search

astral-sh / uv

An extremely fast Python package and project manager, written in Rust.
https://docs.astral.sh/uv
Apache License 2.0
19.45k stars 575 forks source link

Respect CLI option groups in reference documentation #5690

Open zanieb opened 1 month ago

zanieb commented 1 month ago

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

eth3lbert commented 1 month ago

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

zanieb commented 1 month ago

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 commented 1 month ago
  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.