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

docs: rewrite show section as two separate modes for clarity #9752

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

elliot-100
Copy link
Contributor

@elliot-100 elliot-100 commented Oct 10, 2024

I feel that from a user's POV, poetry show has two fairly separate modes, 'list packages' and 'single package info'.

  • This PR separates them in documentation, which I feel is clearer.

    For example it shows that 'single package info' only has one useful option, -tree --why.

    (I think the code should probably be refactored to better separate the cases and drop a few interactions between but that's one for another day.)

  • It adds missing example for the `list packages' mode.

  • It explains what 'poetry show' actually tells you, resolving my very old discussion question What does `poetry show` actually tell me? #7311.

  • It also improves ordering of options and wording.

  • It does not attempt to cover all the colour coding that may appear in show output. To be honest it's inacesssible design to use colour alone to convey information.

[TODO: check CLI --help text and error messages]

Pull Request Check List

Resolves: #7311

  • Added tests for changed code -- not relevant for docs-only change
  • Updated documentation for changed code -- not relevant for docs-only change

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

Successfully merging this pull request may close these issues.

1 participant