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

More clear documentation for "Entry Points" #1901

Open
Archmonger opened this issue Feb 2, 2025 · 0 comments
Open

More clear documentation for "Entry Points" #1901

Archmonger opened this issue Feb 2, 2025 · 0 comments

Comments

@Archmonger
Copy link

Archmonger commented Feb 2, 2025

The current docs for entry points are a bit ambiguous about whether the example key should be user defined.

For example, with the metadata/#cli docs:

[project.scripts]
cli-name = "pkg.subpkg:func"

At first glance, it appears that cli-name is an actual toml attribute, rather than a user defined value. This can be resolved by using one or more of the following methods:

  1. Change cli-name to example-cli-name to give slightly more clear intent
  2. Add a sentence before each example saying Substitute "cli-name" with the namespace you wish to call via command line.
  3. Have every example for within the Entry Points section use at least two commands to demonstrate intent
    [project.scripts]
    cli-name1 = "pkg.subpkg1:func"
    cli-name2 = "pkg.subpkg2:func"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant