Conversation
Links to a different section of text in markdown should use - instead of _ for links with spaces. Also adds a newline before the line break marker in the index.
The usage was only printed if the command has arguments, common for `list` style commands. But these commands should also have a usage section in the docs.
kian99
force-pushed
the
minor-qol-tweaks-v3
branch
from
37f1202 to
eb95f3f
Compare
kian99
changed the title
Contributor
Author
|
@tmihoc This PR makes a change to when |
alesstimec
approved these changes
Dec 4, 2024
tmihoc
approved these changes
Dec 4, 2024
Member
tmihoc
left a comment
tmihoc
left a comment
There was a problem hiding this comment.
Can't comment on the code, but the output looks good to me, thanks!
(I might have follow-up comments once I've looked at an actual real-life example.)
Contributor
Author
|
/merge |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR recreates #120.
This PR makes some minor QoL improvements:
(First commit) Links to a different section of text in markdown should use - instead of _ for links with spaces. If a command has subcommands, the generated markdown currently resemble
#command_subcommandand wouldn't properly navigate, instead#command-subcommandworks.(First commit) There is no line break between the end of the index file and the markdown separator
----which causes issues when converting the markdown to other formats.(Second commit) Always print command usage. The usage is only printed if a command has arguments, commonly empty for
liststyle commands. But these commands should also have a usage section in the docs.