docs: rewrite show section as two separate modes for clarity#9752
Closed
elliot-100 wants to merge 1 commit intopython-poetry:mainfrom
elliot-100:docs/clarify-what-show-does
Closed
docs: rewrite show section as two separate modes for clarity#9752elliot-100 wants to merge 1 commit intopython-poetry:mainfrom elliot-100:docs/clarify-what-show-does
show section as two separate modes for clarity#9752elliot-100 wants to merge 1 commit intopython-poetry:mainfrom
elliot-100:docs/clarify-what-show-does
Conversation
Add example output for 'packages' mode
2 tasks
nbaju1
reviewed
Oct 28, 2024
| If the terminal supports coloured text, packages that aren't installed are shown with their names in red. | ||
|
|
||
| If the terminal doesn't support coloured text, packages that aren't installed are shown with their version prefixed | ||
| with `(!)`. |
There was a problem hiding this comment.
Suggested change
| with `(!)`. | |
| with `(!)`. |
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I feel that from a user's POV,
poetry showhas 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
showoutput. 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