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

Respect CLI option groups in reference documentation #5690

Open
zanieb opened this issue Aug 1, 2024 · 3 comments
Open

Respect CLI option groups in reference documentation #5690

zanieb opened this issue Aug 1, 2024 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@zanieb
Copy link
Member

zanieb commented Aug 1, 2024

Follow-up to #5685, we should group options for readability (as they are in the help menu).

@zanieb zanieb added the documentation Improvements or additions to documentation label Aug 1, 2024
@eth3lbert
Copy link
Contributor

Where should we put the global options? If we create a separate page for each command, would that be better?

@zanieb
Copy link
Member Author

zanieb commented Aug 2, 2024

I worry about the noise of a separate page per command, I like that they're all in the TOC right now not the nav.

I think we could either:

  1. Show the global options in ## uv then link to it from other commands
  2. Show the global options repeatedly per command

@eth3lbert
Copy link
Contributor

  1. Show the global options in ## uv then link to it from other commands

Indeed, this was my first thought.

  1. Show the global options repeatedly per command

And this is why I think it might be too noisy, and it would probably be better to display it on a single page when enabled.

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