Comments (1)
@valpesendorfer Hello!
The usage is rendered directly from Click, and in particular for the command name we use Click's command.name
. As you can see below it transforms underscores into hyphens:
import click
@click.command()
def cli_test():
pass
print(cli_test.name) # "cli-test"
As an alternative, we could consider using command.callback.__name__
. But then explicit name
set on commands wouldn't be honored, and that would be a proper bug. Our best bet to stick to Click's behavior as closely as we can.
So if you'd like the Usage: ...
to show cli_test [OPTIONS] ...
, then you might want to consider doing:
@click.command(name="cli_test")
def cli_test():
pass
I'd agree that looks kind of funky, but that's just how Click treats command names… You could consider digging into issues on the click
repo to see if there's anyone who suggested changing that behavior.
For now, since we have a workaround and it doesn't seem to really be on us, I'll close this for now. Thanks. :-)
from mkdocs-click.
Related Issues (20)
- Support asyncclick?
- Add to mkdocs wiki plugin overview HOT 1
- Multi-command modules not display correctly
- mkdocs serve command fails can't find module specified in :module: attribute HOT 6
- Is it possible to disable the repetition of --help option for every command? HOT 1
- Context/Options not being picked up with multi-commands
- Documentation only renders when there are at least two spaces at the end of .md file HOT 5
- Add option to exclude `hidden` commands, options and groups HOT 3
- Specify subcommands HOT 2
- Support for language-agnostic documentation HOT 2
- `remove_ascii_art` option doesn't work HOT 1
- Escape markdown special characters
- Respect clicks docstring `\b` and `\f` markers
- Generate the CLI documentation without first having to install the Python package
- Can't set up - getting `ModuleNotFoundError` HOT 1
- No output generated at all HOT 2
- Project Status HOT 7
- Indented ::: mkdocs-click blocks are not picked up
- Conflicts with front matter HOT 2
- Option to remove the top level header for the root command
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from mkdocs-click.