diff --git a/docs/configuration.md b/docs/configuration.md index f1fac414dbe..3d1a31bc576 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -454,7 +454,7 @@ that release is not filtered out by this setting. ### `solver.min-release-age-exclude` -**Type**: `string` +**Type**: `array` **Default**: *not set* @@ -462,8 +462,12 @@ that release is not filtered out by this setting. *Introduced in 2.4.0* -A comma-separated list of package names that should be excluded from the +A list of package names that should be excluded from the [`solver.min-release-age`](#solvermin-release-age) filter. +When setting the value with `poetry config` or the environment variable, +provide a comma-separated list. When setting it directly in `poetry.toml`, +use a TOML array. + Versions of these packages will always be considered by the solver, regardless of their upload age. @@ -471,9 +475,14 @@ regardless of their upload age. poetry config solver.min-release-age-exclude "my-package,other-package" ``` +```toml title="poetry.toml" +[solver] +min-release-age-exclude = ["my-package", "other-package"] +``` + ### `solver.min-release-age-exclude-source` -**Type**: `string` +**Type**: `array` **Default**: *not set* @@ -481,8 +490,12 @@ poetry config solver.min-release-age-exclude "my-package,other-package" *Introduced in 2.4.0* -A comma-separated list of source names or URLs that should be excluded from the +A list of source names or URLs that should be excluded from the [`solver.min-release-age`](#solvermin-release-age) filter. +When setting the value with `poetry config` or the environment variable, +provide a comma-separated list. When setting it directly in `poetry.toml`, +use a TOML array. + All packages from these sources will always be considered by the solver, regardless of their upload age. Sources can be referenced by the name defined in `pyproject.toml` or by URL. @@ -491,6 +504,11 @@ Sources can be referenced by the name defined in `pyproject.toml` or by URL. poetry config solver.min-release-age-exclude-source "private-repo,https://example.com/simple/" ``` +```toml title="poetry.toml" +[solver] +min-release-age-exclude-source = ["private-repo", "https://example.com/simple/"] +``` + ### `system-git-client` **Type**: `boolean`