Skip to content
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

Closed
ChrisKeefe opened this issue Feb 27, 2022 · 2 comments
Closed

documentation about entry points is unclear #2206

ChrisKeefe opened this issue Feb 27, 2022 · 2 comments
Labels
Milestone

Comments

@ChrisKeefe
Copy link

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.

  1. Though Shell Completion depends on users installing through a setuptools entrypoint, and refers to the Setuptools Integration docs, the terminology is not aligned between the two sets of examples. Scripts in Packages refers to the package yourpackage, a subpackage scripts, a module yourscript, and a click command cli. Shell Completion refers to PROG_NAME, "the executable name in uppercase...". Does PROG_NAME map to the the name of the package yourscript, the entrypoint yourscript, the command cli, or something else entirely? Clarification of exactly what the "executable name" is here would be very helpful.
  2. In the Scripts in Packages example, it is unclear that the 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.
  • Python version: 3.8
  • Click version: 8
@davidism
Copy link
Member

Happy to review a PR.

@davidism davidism added the docs label Feb 27, 2022
@davidism davidism changed the title DOCS: shell-completion and setuptools-integration unclear documentation about entry points is unclear Feb 27, 2022
@j7an
Copy link
Contributor

j7an commented May 20, 2024

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
@davidism davidism added this to the 8.1.8 milestone May 22, 2024
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jun 7, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

No branches or pull requests

4 participants