Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feature request: Add documentation for events and formatter.format option #645

Open
1 task done
aShabat opened this issue Feb 10, 2025 · 1 comment
Open
1 task done
Labels
enhancement New feature or request P2 Not a priority. PRs welcome

Comments

@aShabat
Copy link

aShabat commented Feb 10, 2025

Did you check existing requests?

  • I have searched the existing issues

Describe the feature

Can you add documentation for ConformCommandPre and ConformCommandPost events and for formatters.[name].format option?
I understand that format option is not intended for active use, but you wrote about it in #186, so it would be nice to have some explanation.

Provide background

I was looking at a way to run mini.align as a formatter. Both events and format option provide a way to do that, but I had to dig a bit to find them.

What is the significance of this feature?

nice to have

Additional details

No response

@aShabat aShabat added the enhancement New feature or request label Feb 10, 2025
@stevearc
Copy link
Owner

These are niche topics that I would actually want to steer the average user away from. If someone wants to make a PR to add some docs under the "advanced topics" section or similar, I would review it.

@stevearc stevearc added the P2 Not a priority. PRs welcome label Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request P2 Not a priority. PRs welcome
Projects
None yet
Development

No branches or pull requests

2 participants