Skip to content

Reformat "Important Files" section in compiler.rst #1004

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 15, 2022

Conversation

ezio-melotti
Copy link
Member

This is a follow-up of #984 that reformats the "Important Files" section in compiler.rst:

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.

In the PR I added links to the files using :cpy-file: and reformatted the list.

Before:
image
After:
image

Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

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

Couple more deleted files, the rest look okay.

Otherwise looks good, thanks!

@ezio-melotti
Copy link
Member Author

The deleted files are tracked in #1003.

@CAM-Gerlach
Copy link
Member

If we're reformatting the whole section like this, maybe worth fixing the lexicographic order too while we're at it?

@ezio-melotti
Copy link
Member Author

I think they are roughly sorted from most to least important.

Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

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

LGTM then, thanks @ezio-melotti

@ezio-melotti ezio-melotti merged commit e0fa2bd into python:main Dec 15, 2022
@ezio-melotti ezio-melotti deleted the reformat-compiler-files branch December 15, 2022 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants