Skip to content

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

Merged
ezio-melotti merged 2 commits intopython:mainfrom
ezio-melotti:reformat-compiler-files
Dec 15, 2022
Merged

Reformat "Important Files" section in compiler.rst#1004
ezio-melotti merged 2 commits intopython:mainfrom
ezio-melotti:reformat-compiler-files

Conversation

@ezio-melotti
Copy link
Copy Markdown
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

@ezio-melotti ezio-melotti added the type-feature Additions; New content or section needed label Dec 9, 2022
@ezio-melotti ezio-melotti self-assigned this Dec 9, 2022
Comment thread internals/compiler.rst
Copy link
Copy Markdown
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!

Comment thread internals/compiler.rst
Comment thread internals/compiler.rst
@ezio-melotti
Copy link
Copy Markdown
Member Author

The deleted files are tracked in #1003.

@CAM-Gerlach
Copy link
Copy Markdown
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
Copy Markdown
Member Author

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

Copy link
Copy Markdown
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

Labels

type-feature Additions; New content or section needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants