Provide a help string when registering commands #154
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
I don't know when it was added, but `command script add` has a --help flag, which defines the help text to show in the output of the `help` command. This change calls the description method on each command, extracts the first line, and then passes that as the help string when registering the command.
ghost
added
the
| @@ -41,6 +41,7 @@ def loadCommandsInDirectory(commandsDirectory): | |||
| def loadCommand(module, command, directory, filename, extension): | |||
| func = makeRunCommand(command, os.path.join(directory, filename + extension)) | |||
| name = command.name() | |||
| helpText = command.description().split('\n', 1)[0] # first line of description | |||
There was a problem hiding this comment.
You could also use str.splitlines() here instead, unless the maxsplit=1 here is important to you.
There was a problem hiding this comment.
That's definitely more readable. The use of maxsplit was to avoid doing more work than necessary.
|
LGTM! |
|
✨ |
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.
I don't know when it was first added, but
command script addhas a--helpflag, which defines the help text to show in the output of thehelpcommand.This change calls the description method on each command, extracts the first line, and then passes that as the help string when registering the command.
Example output: