Update description of --why flag for poetry show#8817
Merged
radoering merged 5 commits intopython-poetry:masterfrom Dec 27, 2023
valentincalomme:docs/improve-poetry-show-why-description
Merged
Update description of --why flag for poetry show#8817radoering merged 5 commits intopython-poetry:masterfrom valentincalomme:docs/improve-poetry-show-why-description
radoering merged 5 commits intopython-poetry:masterfrom
valentincalomme:docs/improve-poetry-show-why-description
Conversation
radoering
reviewed
Dec 25, 2023
Changes: - Update description in `docs/cli.md` - Kept the description in the `docs` in sync with the `cli` by updating `src/poetry/console/commands/show.py` Motivation: The current description was unclear. "display why a package is included" could suggest that users could get back a motivation or rationale behind why the package is added. But that's not the case. `--why` returns whether a package is a direct dependency or whether it is itself a dependency of another package in the project. Also see: #8816
Process review comments Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com>
Process review comments Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com>
radoering
approved these changes
Dec 27, 2023
|
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.
Resolves: #8816
Changes:
docs/cli.mddocsin sync with thecliby updatingsrc/poetry/console/commands/show.pyMotivation:
The current description was unclear. "display why a package is included" could suggest that users could get back a motivation or rationale behind why the package is added. But that's not the case.
--whyreturns whether a package is a direct dependency or whether it is itself a dependency of another package in the project.