Fix writing INI and man pages for subcommands #296
Merged
Conversation
This file contains 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
Whereas a 'bar' subcommand under 'foo' should have the section name 'foo.bar', it was being written as 'bar.'.
Previously, the usage text of a sub command on the man page would only include the direct parent command's name. A `foo` utility with `bar` command and `baz` subcommand would give `baz`s usage as ``` Usage: bar [OPTIONS] baz [baz-OPTIONS] ``` instead of ``` Usage: foo [OPTIONS] bar [bar-OPTIONS] baz [baz-OPTIONS] ```
rupertchen
force-pushed
the
fix-sub-commands
branch
from
61c8d49 to
d71158e
Compare
|
Addressed |
|
@jessevdk , are you still maintaining this project? |
|
@jessevdk , ping |
11 tasks
# for free
to join this conversation on GitHub.
Already have an account?
# to comment
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.
This PR addresses two issues pertaining to subcommands: writing the INI and writing the man pages.
The work is split across two commits. The first commit addresses an issue where INI sections for subcommands were written as
[sub.]instead of[parent.sub]. The second commit addresses an issue with usage text in man pages where commands only included the usage text of their immediate parent instead of a complete usage starting from the root.