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

uv tool help may be confusing #8210

Open
callegar opened this issue Oct 15, 2024 · 4 comments
Open

uv tool help may be confusing #8210

callegar opened this issue Oct 15, 2024 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@callegar
Copy link

callegar commented Oct 15, 2024

uv tool install --help and uv tool update --help mention pinning that is not described in the same help lines.

@zanieb
Copy link
Member

zanieb commented Oct 15, 2024

Can you share an example?

@callegar
Copy link
Author

Sure:
uv tool install --help results in:

...
  -U, --upgrade                            Allow package upgrades, ignoring pinned versions ...
  -P, --upgrade-package <UPGRADE_PACKAGE>  Allow upgrades for a specific package, ignoring pinned versions ...
...

However, these are the only mentions to pinning in this help text. There is no mention on how to pin something related to tools or how something related to tools might get pinned. If pinning happens with another subcommand where the help text describes it, probably there should be a 'see also'...

@callegar
Copy link
Author

For what concerns --refresh, it was my mistake, sorry for the noise...

@zanieb
Copy link
Member

zanieb commented Oct 15, 2024

Thanks!

@zanieb zanieb self-assigned this Oct 15, 2024
@zanieb zanieb added the documentation Improvements or additions to documentation label Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants