-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
doc: improve Editor Integration section #3307
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
Conversation
Hey, thank you for opening your first Pull Request ! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left some comments. Please consider and slightly change the code.
Turn editor integration nested list of descriptions into headers and descriptions under. This facilitates linking to headers within the generated docs, is more consistent with the following Shell Completion section which uses this style, and I find it easier to read
Co-authored-by: Oleksandr Redko <oleksandr.red+github@gmail.com>
Thanks for updating the patch @ldez ! Anything more I can do here? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks 👍
@alexandear can you approve? |
Turn editor integration nested list of descriptions into headers and descriptions under. This facilitates linking to headers within the generated docs, is more consistent with the following Shell Completion section which uses this style, and I find it easier to read