Use VisibleFlags during doc generation #999
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
Codecov Report
@@ Coverage Diff @@
## master #999 +/- ##
=========================================
Coverage ? 73.38%
=========================================
Files ? 32
Lines ? 2435
Branches ? 0
=========================================
Hits ? 1787
Misses ? 539
Partials ? 109
Continue to review full report at Codecov.
|
coilysiren
previously approved these changes
Dec 18, 2019
rliebz
previously approved these changes
Dec 18, 2019
saschagrunert
previously approved these changes
Dec 19, 2019
|
Thanks for the fix, @subpop :) |
Hidden commands are excluded during doc generation but hidden flags are not. Using VisibleFlags() instead of the Flags slice fixes that. Signed-off-by: Link Dupont <link@sub-pop.net>
subpop
dismissed stale reviews from saschagrunert, rliebz, and coilysiren
via
777b332
|
Ugh, sorry. Rebased this change onto master and it invalidated the approvals. :( |
rliebz
approved these changes
Dec 19, 2019
coilysiren
approved these changes
Dec 20, 2019
saschagrunert
approved these changes
Dec 20, 2019
Merged
This was referenced May 21, 2021
Closed
This was referenced Jun 6, 2021
Closed
1 task
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.
Motivation
Hidden commands are excluded during doc generation but hidden flags are not. This results in generated documentation (man pages and markdown) including hidden flags in the output. Using
VisibleFlags()instead of theFlagsslice filters out hidden flags before preparing them for document output.Testing
I added a hidden flag to the testApp. Test output should remain unchanged, since hidden flags should not be included in documentation output.