You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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:
Change cli-name to example-cli-name to give slightly more clear intent
Add a sentence before each example saying Substitute "cli-name" with the namespace you wish to call via command line.
Have every example for within the Entry Points section use at least two commands to demonstrate intent
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: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:cli-name
toexample-cli-name
to give slightly more clear intentSubstitute "cli-name" with the namespace you wish to call via command line.
The text was updated successfully, but these errors were encountered: