From efbb5ceb4865504f7d43253f7cdd191e078d0dd1 Mon Sep 17 00:00:00 2001 From: Tom Solberg Date: Sat, 21 May 2022 13:47:48 +0200 Subject: [PATCH] doc: clarify`--why` command --- docs/cli.md | 3 ++- src/poetry/console/commands/show.py | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index 81768824df0..d1765fc85ec 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -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**) @@ -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. diff --git a/src/poetry/console/commands/show.py b/src/poetry/console/commands/show.py index 8764595c3e3..e5e91cb363d 100644 --- a/src/poetry/console/commands/show.py +++ b/src/poetry/console/commands/show.py @@ -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 --tree for a single package," + " also display why it's included.", ), option("latest", "l", "Show the latest version."), option(