Document package sources for self update - #10923
Merged
radoering merged 3 commits intoJun 21, 2026
Merged
Conversation
Mirochill
marked this pull request as ready for review
May 26, 2026 19:35
radoering
force-pushed
the
docs-10633-self-update-source
branch
from
June 21, 2026 11:14
233b210 to
bb50291
Compare
|
Deploy preview for website ready!
Deployed with vercel-action |
Member
|
@sourcery-ai review |
There was a problem hiding this comment.
Hey - I've found 3 issues
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/cli.md" line_range="957-960" />
<code_context>
{{% note %}}
-The `self install` command works similar to the [`install` command](#install). However,
-it is different in that the packages managed are for Poetry's runtime environment.
+The `self install` command works similar to the [`install` command](#install).
+However, it is different in that the packages managed are for Poetry's runtime environment.
{{% /note %}}
</code_context>
<issue_to_address>
**nitpick (typo):** Consider changing "works similar to" to "works similarly to" for grammatical correctness.
Because "works" needs an adverb here, please change this to "works similarly to the [`install` command]" for grammatical accuracy.
```suggestion
{{% note %}}
The `self install` command works similarly to the [`install` command](#install).
However, it is different in that the packages managed are for Poetry's runtime environment.
{{% /note %}}
```
</issue_to_address>
### Comment 2
<location path="docs/cli.md" line_range="1032" />
<code_context>
{{% note %}}
-The `self sync` command works similar to the [`sync` command](#sync). However,
-it is different in that the packages managed are for Poetry's runtime environment.
+The `self sync` command works similar to the [`sync` command](#sync).
+However, it is different in that the packages managed are for Poetry's runtime environment.
{{% /note %}}
</code_context>
<issue_to_address>
**nitpick (typo):** Use "similarly" instead of "similar" after "works".
“Works similarly to the [`sync` command]” is the idiomatic phrasing; “works similar to” is ungrammatical in standard English.
```suggestion
The `self sync` command works similarly to the [`sync` command](#sync).
```
</issue_to_address>
### Comment 3
<location path="docs/cli.md" line_range="1046" />
<code_context>
The `self update` command updates Poetry version in its current runtime environment.
{{% note %}}
</code_context>
<issue_to_address>
**suggestion (typo):** Clarify "updates Poetry version" by adding an article or possessive.
Rephrase as "updates the Poetry version" or "updates Poetry's version" for grammatical completeness and clarity.
```suggestion
The `self update` command updates the Poetry version in its current runtime environment.
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
radoering
approved these changes
Jun 21, 2026
1 task
|
This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Check List
Resolves: #10633
Summary:
poetry selfcommands use a systempyproject.tomlin Poetry's configuration directory.poetry self updatereads package sources from that system project, not from the current project'spyproject.toml.[[tool.poetry.source]]format to the package sources documentation.Validation:
git diff --checkrg -n "system project|configuration#config-directory|repositories/#package-sources|tool\.poetry\.source|current project.*self update|preserves existing" docs\cli.mdNot run locally: documentation build, tests, or pre-commit.