Allow options to contain multiple words #60
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
Hnasar
force-pushed
the
master
branch
2 times, most recently
from
c09ec97
to
2a6ea83
Compare
When documenting subcommands, sometimes mkdocs-click will only show the
subcommand name. `:prog_name:` seems to be the right option to ensure
the actuall command is shown, but due to an overly-strict regex, it
used to ignore everything after the first whitespace. With this change,
`prog_name` and other commands can contain multiple words in their
values.
For example
```
::: mkdocs-click
:module: foo.utils.bridge
:prog_name: foo-utils bridge
:command: cli
```
now properly renders as
> foo-utils bridge [OPTIONS]
instead of
> foo-utils [OPTIONS]
or
> bridge [OPTIONS]
(^^ if prog_name wasn't specified at all)
Co-Authored-By: Bar Hochman <bhochman@paloaltonetworks.com>
Fixes mkdocs#42
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.
This PR is based on and supersedes the one in #44. I added more explanation, a test, and fixed a small bug with trailing whitespace.
When documenting subcommands, sometimes mkdocs-click will only show the
subcommand name.
:prog_name:seems to be the right option to ensurethe actuall command is shown, but due to an overly-strict regex, it
used to ignore everything after the first whitespace. With this change,
prog_nameand other commands can contain multiple words in theirvalues.
For example
now properly renders as
instead of
or
(^^ if prog_name wasn't specified at all)
Co-Authored-By: Bar Hochman bhochman@paloaltonetworks.com