From e2551ba0891858359e2e2472ef1da14195894997 Mon Sep 17 00:00:00 2001 From: Hugo Buddelmeijer Date: Tue, 19 Nov 2024 11:11:11 +0100 Subject: [PATCH 1/3] Clarify that poetry update only updates main dependencies Add a note that `--with` is required to have `poetry update` also update optional dependency groups. --- docs/cli.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index 5d5717962a4..0a47369947d 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -281,7 +281,7 @@ you should use the `update` command. poetry update ``` -This will resolve all dependencies of the project and write the exact versions into `poetry.lock`. +This will resolve all main dependencies of the project and write the exact versions into `poetry.lock`. If you just want to update a few packages and not all, you can list them as such: @@ -310,6 +310,11 @@ You can do this using the `add` command. When `--only` is specified, `--with` and `--without` options are ignored. {{% /note %}} +{{% note %}} +`poetry update` without any options will only update the main dependencies of the project. +Optional dependency groups are only updated when they are specified through `--with`. +{{% /note %}} + ## add The `add` command adds required packages to your `pyproject.toml` and installs them. From 1e2a3e50b41e1690f3a3126ca606b380c4fad79f Mon Sep 17 00:00:00 2001 From: Hugo Buddelmeijer Date: Tue, 19 Nov 2024 13:37:04 +0100 Subject: [PATCH 2/3] Clarify that the poetry file is updated for all dependencies The poetry file is updated, just not the installed packages --- docs/cli.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/cli.md b/docs/cli.md index 0a47369947d..cdec0025a24 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -281,7 +281,8 @@ you should use the `update` command. poetry update ``` -This will resolve all main dependencies of the project and write the exact versions into `poetry.lock`. +This will resolve all dependencies of the project, write the exact versions into `poetry.lock`, +and subsequently update the main dependencies. If you just want to update a few packages and not all, you can list them as such: From fd2965285fe70f3e451f3d7fd4b7e3832e175faf Mon Sep 17 00:00:00 2001 From: Hugo Buddelmeijer Date: Tue, 19 Nov 2024 13:51:59 +0100 Subject: [PATCH 3/3] Update cli.md Clarify that it is the non-optional dependencies that are updated --- docs/cli.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index cdec0025a24..a895a9d211f 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -282,7 +282,7 @@ poetry update ``` This will resolve all dependencies of the project, write the exact versions into `poetry.lock`, -and subsequently update the main dependencies. +and subsequently update the non-optional dependencies. If you just want to update a few packages and not all, you can list them as such: @@ -312,7 +312,7 @@ When `--only` is specified, `--with` and `--without` options are ignored. {{% /note %}} {{% note %}} -`poetry update` without any options will only update the main dependencies of the project. +`poetry update` without any options will only update the non-optional dependencies of the project. Optional dependency groups are only updated when they are specified through `--with`. {{% /note %}}