GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Reformat "Important Files" section in `compiler.rst` by ezio-melotti · Pull Request #1004 · python/devguide

Conversation

@ezio-melotti

@ezio-melotti 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:
image
After:
image

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
ezio-melotti added 2 commits December 9, 2022 03:14
@ezio-melotti
Reformat the "Important file" section.
d9bfe4d
@ezio-melotti
More reformatting.
aad34d2
@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
hugovk
hugovk reviewed Dec 9, 2022
View reviewed changes
Comment thread internals/compiler.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

hugovk
hugovk reviewed Dec 9, 2022
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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!

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread internals/compiler.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread internals/compiler.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@ezio-melotti

ezio-melotti commented Dec 9, 2022

Copy link
Copy Markdown
Member Author

The deleted files are tracked in #1003.

hugovk reacted with thumbs up emoji
All reactions
  • 👍 1 reaction

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

hugovk
hugovk approved these changes Dec 9, 2022
View reviewed changes
@CAM-Gerlach

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?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@ezio-melotti

ezio-melotti commented Dec 10, 2022

Copy link
Copy Markdown
Member Author

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

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

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

@CAM-Gerlach CAM-Gerlach left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this 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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

ezio-melotti reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@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

Reviewers

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

Uh oh!

There was an error while loading. Please reload this page.

Assignees

@ezio-melotti 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.

Uh oh!

There was an error while loading. Please reload this page.

3 participants

@ezio-melotti @CAM-Gerlach @hugovk
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.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.