Repository navigation
📝 docs: fix dead links in two code comments - #3463
Merged
Merged
Conversation
gaborbernat
changed the title
patch_dist carried a docstring that restated its comment and ran past 120 characters; the reason and link now share one comment. The PyPy link says why the shared libraries are copied.
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.
Two links in code comments were dead. 📝 The
patch_distdocstring pointed at the distutils configuration file section of the Python docs, which went away with distutils, so it now links to the Python 3.11 copy where the section still exists. The PyPy shared library comment pointed at a Bitbucket issue, and PyPy now tracks the same issue at pypy/pypy#1922.Only comments change, so runtime behavior stays the same.
ran the linter to address style issues (
tox -e fix)wrote descriptive pull request text
ensured there are test(s) validating the fix
added news fragment in
docs/changelogfolderupdated/extended the documentation
for changes to activation scripts,
pyvenv.cfg, wheel downloads, app-data or release workflows: explained in the PR text which outside input the change handles, such as a path, a prompt or a downloaded file, and how it stops that input from running as code. See the security scope.ran tests on Python 3.9 and 3.15 (
tox run -e 3.9,3.15)linked upstream issues beside any temporary interpreter overrides
kept the PR in draft until CI passes