{{ message }}
Use :cpy-file: throughout the Devguide#984
Merged
ezio-melotti merged 3 commits intoDec 9, 2022
Merged
Conversation
ezio-melotti
commented
Nov 14, 2022
hugovk
approved these changes
Nov 29, 2022
hugovk
left a comment
Member
There was a problem hiding this comment.
Gave a few a spot check, looks good.
Sorry, something went wrong.
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
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.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.
This PR replaces the use of
:file:with:cpy-file:(introduced in #961) in most places. Since the generated links are now checked bymake linkcheck, I also went through and corrected some of those.There are a few broken links that I haven't touched yet:
Include/Python-ast.hwas removed by @vstinnerInclude/token.hwas removed by @vstinnerInclude/code.hwas removed by @vstinnerPython/peephole.cwas removed by @markshannonThe respective sections in
developer-workflow/grammar.rstandinternals/compiler.rstmight need to be revisited.@vstinner and @markshannon: can you advise on whether these are quick fixes that we can include in this PR or if they should be handled separately?
I also found another issue with this section: https://devguide.python.org/internals/compiler/#important-files
In addition to the fact that the listed files don't use any markup, the markup used for most of the files seem incorrect (it's a blockquote due to the indentation). A nested list with full paths for all the files and
:cpy-file:should be a better alternative.The
:cpy-file:role could also be improved to support~, so that in that list (and in a few other places) we can hide the full path and just display the file name.