Skip to content

Document package sources for self update - #10923

Merged
radoering merged 3 commits into
python-poetry:mainfrom
Mirochill:docs-10633-self-update-source
Jun 21, 2026
Merged

radoering merged 3 commits into
python-poetry:mainfrom
Mirochill:docs-10633-self-update-source

Conversation

@Mirochill

Copy link
Copy Markdown
Contributor

Pull Request Check List

Resolves: #10633

  • Added tests for changed code.
  • Updated documentation for changed code.

Summary:

  • Document that poetry self commands use a system pyproject.toml in Poetry's configuration directory.
  • Clarify that poetry self update reads package sources from that system project, not from the current project's pyproject.toml.
  • Link the [[tool.poetry.source]] format to the package sources documentation.

Validation:

  • git diff --check
  • rg -n "system project|configuration#config-directory|repositories/#package-sources|tool\.poetry\.source|current project.*self update|preserves existing" docs\cli.md

Not run locally: documentation build, tests, or pre-commit.

@Mirochill
Mirochill marked this pull request as ready for review May 26, 2026 19:35

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
@radoering
radoering force-pushed the docs-10633-self-update-source branch from 233b210 to bb50291 Compare June 21, 2026 11:14
@radoering radoering added area/docs Documentation issues/improvements impact/docs Contains or requires documentation changes labels Jun 21, 2026
@github-actions

github-actions Bot commented Jun 21, 2026 •

Copy link
Copy Markdown

Deploy preview for website ready!

Project:website
Status: ✅  Deploy successful!
Preview URL:https://website-iywdr5p70-python-poetry.vercel.app
Latest Commit:9788c1d

Deployed with vercel-action

@radoering

Copy link
Copy Markdown
Member

@sourcery-ai review

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Comment thread docs/cli.md
Comment thread docs/cli.md Outdated
Comment thread docs/cli.md Outdated
@radoering
radoering merged commit 648abab into python-poetry:main Jun 21, 2026
53 checks passed
@radoering radoering removed impact/docs Contains or requires documentation changes area/docs Documentation issues/improvements labels Jun 21, 2026
@github-actions

Copy link
Copy Markdown

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.

@github-actions github-actions Bot locked as resolved and limited conversation to collaborators Jul 22, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

2 participants