Allow hiding of supercommand documentation #107
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
The following allows the hiding of the supercommand documentation. It's not always required to show the supercommand documentation, it doesn't always give you anything. To enable that, we just add a new flag on the supercommand to skip it during documentation output.
barrettj12
suggested changes
Aug 15, 2023
Add a note about how we should remove this feature and replace it with a better abstraction.
SimonRichardson
force-pushed
the
allow-hidden-super-command-indexes
branch
from
0928790 to
204135f
Compare
The writeDocs method was doing too much. Instead we have a writeDoc method that just does one thing. Writing the doc.
barrettj12
approved these changes
Aug 15, 2023
|
/merge |
1 similar comment
|
/merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in 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.
The following allows the hiding of the supercommand documentation. It's not always required to show the supercommand documentation. Most supercommands (wait-for, jujud, container-agent) don't always give you anything of any importance or worthwhile.
To enable that, we just add a new flag on the supercommand to skip it during documentation output.
This is the fix for #100