add document source for each group #712
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
| yield '' | ||
| yield '{}:summary: {}'.format(INDENT, help_file.short_summary) | ||
| yield '{}:description: {}'.format(INDENT, help_file.long_summary) | ||
| yield '{}:docsource: {}'.format(INDENT, help_file.doc_source) |
There was a problem hiding this comment.
it looks like we would need to specify docsource in every help file. I'd much rather have a simple check that switches on the first param in the help file path to determine the help file path. Example (untested):
switches = {
'ad': '<path to ad _help.py',
'login': '',
etc.
}
docsource = switches[help_file.command.split()[0]] #Resolved
There was a problem hiding this comment.
I add dedicated dictionary to store the map between group name and the help file path since they are not exactly one-one map, e.g. 'resource' and 'tag' are mapped to same help file under resource module.
The only shortcoming is we must maintain the dictionary if moving the help files. #Closed
|
|
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.
add field docsource to support document contribution from community.
CI builder server will map the docsource to http path in this repo.