-
Notifications
You must be signed in to change notification settings - Fork 2.4k
docs: clarify local vs global config precedence (#10329) #10676
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.
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
base: main
Are you sure you want to change the base?
docs: clarify local vs global config precedence (#10329) #10676
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideDocuments that when the same configuration key is set both locally in poetry.toml and globally in config.toml, the local/project setting takes precedence, by adding a note to the configuration documentation. File-Level Changes
Possibly linked issues
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hey - I've found 1 issue, and left some high level feedback:
- While you’re updating this section, consider fixing the existing shortcode mismatch where the
{{% warning %}}block is closed with{{% /note %}}, which could lead to rendering issues in the docs.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- While you’re updating this section, consider fixing the existing shortcode mismatch where the `{{% warning %}}` block is closed with `{{% /note %}}`, which could lead to rendering issues in the docs.
## Individual Comments
### Comment 1
<location> `docs/configuration.md:43-44` </location>
<code_context>
+the local/project configuration takes precedence over the global configuration.
+{{% /note %}}
+
{{% warning %}}
Be mindful about checking in this file into your repository since it may contain user-specific or sensitive information.
{{% /note %}}
</code_context>
<issue_to_address>
**suggestion (typo):** Consider rephrasing this sentence to avoid the awkward "checking in this file into" construction.
The phrase "Be mindful about checking in this file into your repository" is grammatically awkward because of the "about … into" combination. Consider rewording to something like "Be mindful when checking this file into your repository" or "Be mindful about checking this file into your repository" for better flow.
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
docs/configuration.md
Outdated
| {{% warning %}} | ||
| Be mindful about checking in this file into your repository since it may contain user-specific or sensitive information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
suggestion (typo): Consider rephrasing this sentence to avoid the awkward "checking in this file into" construction.
The phrase "Be mindful about checking in this file into your repository" is grammatically awkward because of the "about … into" combination. Consider rewording to something like "Be mindful when checking this file into your repository" or "Be mindful about checking this file into your repository" for better flow.
c48c984 to
8d0ec74
Compare
This PR clarifies how Poetry handles conflicting configuration settings when the same setting is defined both locally (in poetry.toml) and globally (in config.toml).
A new note has been added to the Configuration documentation:
Note: If a setting is defined in both poetry.toml (local/project) and config.toml (global), the local/project configuration takes precedence over the global configuration.
This change helps contributors and users understand which configuration will apply without needing to test it themselves.
No code changes were made—only the documentation has been updated.
Summary by Sourcery
Documentation: