Conversation
Both anchors (#adding-a-repository, #using-a-private-repository) were orphaned when repositories.md was rewritten in python-poetry#10941; point at the existing 'Package sources' and 'Private repository example' sections.
There was a problem hiding this comment.
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path="docs/libraries.md" line_range="131" />
<code_context>
In order to publish to a private repository, you will need to add it to your
-global list of repositories. See [Adding a repository]({{< relref "repositories#adding-a-repository" >}})
+global list of repositories. See [Package sources]({{< relref "repositories#package-source-constraint" >}})
for more information.
</code_context>
<issue_to_address>
**issue:** The “Package sources” link lands on the “Package Source Constraint” subsection, which only explains restricting dependency resolution to a source; it does not explain adding a user-level publishing repository. Readers following the publishing instructions therefore still cannot find the required repository configuration.
**Triggers:** When a library author follows the link to configure a private publishing repository.
**Suggested fix:** Link to `repositories#publishable-repositories`, which documents configuring repositories used for publishing.
```suggestion
global list of repositories. See [Package sources]({{< relref "repositories#publishable-repositories" >}})
```
</issue_to_address>Sourcery assessment
Approval pending. 1 finding to address first.
Blocking findings: docs/libraries.md:131
|
|
||
| In order to publish to a private repository, you will need to add it to your | ||
| global list of repositories. See [Adding a repository]({{< relref "repositories#adding-a-repository" >}}) | ||
| global list of repositories. See [Package sources]({{< relref "repositories#package-source-constraint" >}}) |
There was a problem hiding this comment.
issue: The “Package sources” link lands on the “Package Source Constraint” subsection, which only explains restricting dependency resolution to a source; it does not explain adding a user-level publishing repository. Readers following the publishing instructions therefore still cannot find the required repository configuration.
Triggers: When a library author follows the link to configure a private publishing repository.
Suggested fix: Link to repositories#publishable-repositories, which documents configuring repositories used for publishing.
Suggested change
| global list of repositories. See [Package sources]({{< relref "repositories#package-source-constraint" >}}) | |
| global list of repositories. See [Package sources]({{< relref "repositories#publishable-repositories" >}}) |
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The anchors
repositories#adding-a-repository(docs/libraries.md:131) andrepositories#using-a-private-repository(docs/pyproject.md:801) no longer match any heading — they were orphaned when repositories.md was rewritten in #10941 (verified viagit log -Sand the heading list). Repointed at the existing#package-source-constraintand#private-repository-examplesections, which cover the referenced content.