FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Reformat "Important Files" section in `compiler.rst` by ezio-melotti · Pull Request #1004 · python/devguide · GitHub

/ devguide Public

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

Merged
ezio-melotti merged 2 commits into
python:mainfrom
ezio-melotti:reformat-compiler-files
Dec 15, 2022
ConversationCommits (2)ChecksFiles changed
Merged

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

Conversation

ezio-melotti commented Dec 9, 2022

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:

After:

ezio-melotti added the type-feature Additions; New content or section needed label Dec 9, 2022
ezio-melotti self-assigned this Dec 9, 2022
hugovk reviewed Dec 9, 2022
View reviewed changes
Comment thread internals/compiler.rst
hugovk reviewed Dec 9, 2022
View reviewed changes

hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Couple more deleted files, the rest look okay.

Otherwise looks good, thanks!

Comment thread internals/compiler.rst
Comment thread internals/compiler.rst

ezio-melotti commented Dec 9, 2022

Copy link
Copy Markdown
Member Author

The deleted files are tracked in #1003.

CAM-Gerlach commented Dec 9, 2022

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 commented Dec 10, 2022

Copy link
Copy Markdown
Member Author

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

CAM-Gerlach approved these changes Dec 15, 2022
View reviewed changes

CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

LGTM then, thanks @ezio-melotti

ezio-melotti merged commit e0fa2bd into python:main Dec 15, 2022
ezio-melotti deleted the reformat-compiler-files branch December 15, 2022 17:07
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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk approved these changes
CAM-Gerlach CAM-Gerlach approved these changes

Assignees

ezio-melotti

Labels

type-feature Additions; New content or section needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

Back | FazBrowse Home | New Git URL