-
-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
documentation about entry points is unclear #2206
Comments
Happy to review a PR. |
davidism
changed the title
DOCS: shell-completion and setuptools-integration unclear
documentation about entry points is unclear
Feb 27, 2022
Currently working on issue for sprint. |
j7an
added a commit
to j7an/click
that referenced
this issue
May 20, 2024
- Update CONTRIBUTING.rst with latest Click version - Add entry_points specification URL - Clarify shell completion description
j7an
added a commit
to j7an/click
that referenced
this issue
May 20, 2024
- Update CONTRIBUTING.rst with latest Click version - Add entry_points specification URL - Clarify shell completion description
j7an
added a commit
to j7an/click
that referenced
this issue
May 20, 2024
- Update CONTRIBUTING.rst with latest Click version - Add entry_points specification URL - Clarify shell completion description
aenglander
added a commit
that referenced
this issue
May 20, 2024
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
First, thanks for making an awesome tool! Click made knocking together a CLI for my masters work trivial.
These documentation questions are an effort to clarify some of the language in the setuptools and shell completion sections, to reduce friction for new users like me.
yourpackage
, a subpackagescripts
, a moduleyourscript
, and a click commandcli
. Shell Completion refers toPROG_NAME
, "the executable name in uppercase...". DoesPROG_NAME
map to the the name of the packageyourscript
, the entrypointyourscript
, the commandcli
, or something else entirely? Clarification of exactly what the "executable name" is here would be very helpful.console_scripts
key is a "default" value, and not something package-specific. For users who have worked with entrypoints in setup.py before, this is probably obvious, but for newcomers there's no visual way to differentiate "standard" values from semantically meaningful ones in this example. A single-sentence note clarifying would help.The text was updated successfully, but these errors were encountered: