Skip to content

docs: clarify configuration source precedence #10757

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

Open
mitre88 wants to merge 1 commit into
base: main
Choose a base branch
from
+14 −0
Open

docs: clarify configuration source precedence #10757

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 14 additions & 0 deletions docs/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,20 @@ If a setting is defined in both `poetry.toml` (local/project) and `config.toml`
the local/project configuration takes precedence over the global configuration.
{{% /note %}}

## Configuration sources

When a setting is set in multiple places, Poetry applies the following precedence
(from highest to lowest):

1. Environment variables (for example, `POETRY_VIRTUALENVS_CREATE`)
2. The local `poetry.toml` file (created with `poetry config --local`)
3. The global `config.toml` file
4. The setting's default value

For repository credentials (`http-basic.*`, `pypi-token.*`), Poetry may also read
from `auth.toml` and the system keyring. Environment variables still take
precedence over file-based values.

{{% warning %}}
Be mindful when checking in this file into your repository since it may contain user-specific or sensitive information.
Copy link

@sourcery-ai sourcery-ai bot Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

issue (typo): Consider fixing the grammar in this sentence by removing the extra "in".

The current wording is a bit awkward. Consider either "checking this file into your repository" or "checking in this file to your repository" to avoid the duplicated preposition.

Suggested change
Be mindful when checking in this file into your repository since it may contain user-specific or sensitive information.
Be mindful when checking this file into your repository since it may contain user-specific or sensitive information.

{{% /warning %}}
Expand Down