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.

Sign up for GitHub

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

Jump to bottom

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
+4 −3

Commits on Dec 27, 2023

  1. Update description of --why flag for poetry show 

    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
    Valentin Calomme committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    5a9d226 View commit details
    Browse the repository at this point in the history

  2. Fix black formatting

    Valentin Calomme committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    b5f5d59 View commit details
    Browse the repository at this point in the history

  3. Update docs/cli.md 

    Process review comments

Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com>
    @valentincalomme @radoering
    2 people authored and Valentin Calomme committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    7a39c25 View commit details
    Browse the repository at this point in the history

  4. Update src/poetry/console/commands/show.py 

    Process review comments

Co-authored-by: Randy Döring <30527984+radoering@users.noreply.github.com>
    @valentincalomme @radoering
    2 people authored and Valentin Calomme committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    5df2180 View commit details
    Browse the repository at this point in the history

  5. Fix formatting

    Valentin Calomme committed Dec 27, 2023
    Configuration menu
    Copy the full SHA
    0d8511f View commit details
    Browse the repository at this point in the history