Skip to content

clarify documentation for --why command #5653

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

Merged
abn merged 2 commits into from
May 21, 2022
Merged

clarify documentation for --why command #5653

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
80a4db5
clarify docs for --why command
tgolsson May 20, 2022
6ceb911
clarify a bit more
tgolsson May 20, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -444,7 +444,7 @@ required by
### Options

* `--without`: The dependency groups to ignore.
* `--why`: Include reverse dependencies where applicable.
* `--why`: When showing the full list, or a `--tree` for a single package, display why a package is included.
* `--with`: The optional dependency groups to include.
* `--only`: The only dependency groups to include.
* `--default`: Only include the main dependencies. (**Deprecated**)
Expand All @@ -457,6 +457,7 @@ required by
When `--only` is specified, `--with` and `--without` options are ignored.
{{% /note %}}


## build

The `build` command builds the source and wheels archives.
Expand Down
3 changes: 2 additions & 1 deletion src/poetry/console/commands/show.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,8 @@ class ShowCommand(GroupCommand):
option(
"why",
None,
"When listing the tree for a single package, start from parents.",
"When showing the full list, or a <info>--tree</info> for a single package,"
" also display why it's included.",
),
option("latest", "l", "Show the latest version."),
option(
Expand Down