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

Update description of --why flag for poetry show #8817

Merged
merged 5 commits into from
Dec 27, 2023
Merged

Update description of --why flag for poetry show #8817

merged 5 commits into from
Dec 27, 2023

Conversation

valentincalomme
Copy link
Contributor

Resolves: #8816

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.

docs/cli.md Outdated Show resolved Hide resolved
src/poetry/console/commands/show.py Outdated Show resolved Hide resolved
Valentin Calomme and others added 5 commits December 27, 2023 11:24
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 <[email protected]>
Process review comments

Co-authored-by: Randy Döring <[email protected]>
@radoering radoering merged commit f6002e2 into python-poetry:master Dec 27, 2023
33 checks passed
@valentincalomme valentincalomme deleted the docs/improve-poetry-show-why-description branch December 27, 2023 12:14
Copy link

github-actions bot commented Mar 3, 2024

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.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Unclarity with poetry show --why
2 participants