Minor updates related to documentation for commands and more osnadmin updates #2318
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
This change returns an error from `executeForArgs` when the command line cannot be parsed. Without this change, tests that use the function quietly exit without a clear indication as to why. Signed-off-by: Matthew Sykes <sykesmat@us.ibm.com>
yacovm
reviewed
Jan 27, 2021
| @@ -595,7 +595,7 @@ also outputs which organizations have approved the chaincode definition. If an | |||
| organization has approved the chaincode definition specified in the command, the | |||
| command will return a value of true. You can use this command to learn whether enough | |||
| channel members have approved a chaincode definition to meet the | |||
| `/Channel/Application/Endorsement` policy (a majority by default) before the | |||
There was a problem hiding this comment.
Did you remove this with a batch search-replace?
There was a problem hiding this comment.
It's related because it's the output of the automated doc generation for command help. It's clear that commands have been getting updated without regenerating the docs. The regen of the docs was explicitly called out in the commit message.
In this case, commit 49ed882 changed the postscript without updating docs.
In this case, 5df63f1 changed the generated doc instead of the postscript. That change was incorrect.
- Change the generateHelpDocs script to remove trailing spaces from the generated help text. This prevents linting failures from check_trailingspaces.sh - Remove trailing space from osnadmin_channel_postscript.md - Regenerate the help docs with `make help-docs` Signed-off-by: Matthew Sykes <sykesmat@us.ibm.com>
Signed-off-by: Matthew Sykes <sykesmat@us.ibm.com>
sykesm
force-pushed
the
fixup-osnadmin
branch
from
9958657 to
c180630
Compare
yacovm
approved these changes
Jan 27, 2021
|
@sykesm OK to mergifyio this back to the 2.3 branch? |
I think it's better to do it manually. I can do that if you want. |
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.
channel-idthat was included in the osnadmin command help