Skip to content

Internal docs: Update code blocks in garbage_collector.md to improve syntax highlighting #126882

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.

Sign up for GitHub

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

Jump to bottom
Closed
tomasr8 opened this issue Nov 15, 2024 · 2 comments
Closed

Internal docs: Update code blocks in garbage_collector.md to improve syntax highlighting #126882

tomasr8 opened this issue Nov 15, 2024 · 2 comments
Labels
docs Documentation in the Doc dir easy

Comments

@tomasr8
Copy link
Member

tomasr8 commented Nov 15, 2024 •
edited by bedevere-app bot
Loading

Code blocks in garbage_collector.md are annotated with pycon which doesn't play well GitHub's syntax highlighting (and neither with VS Code's Markdown preview):

image

I suggest we change that to python which highlights the code blocks properly:

image

Linked PRs
@tomasr8 tomasr8 added docs Documentation in the Doc dir easy labels Nov 15, 2024
@bhagwant4040

This comment was marked as off-topic.

Sign in to view
javert42 added a commit to javert42/cpython that referenced this issue Nov 15, 2024
@javert42
pythonGH-126882: Fix indentation in code sample block.
961e7a5
@bedevere-app bedevere-app bot mentioned this issue Nov 15, 2024
Merged
@javert42
Copy link
Contributor

javert42 commented Nov 15, 2024 •
edited
Loading

This is my first attempt at a contribution (to any project--not just cpython), so I welcome any feedback!

I still need to sign the CLA, and figure out how step number 8 from the Developer's Guide applies.
I signed the CLA, and I'm assuming this change won't need a NEWS entry.

@AbhishekKumar0313 AbhishekKumar0313 mentioned this issue Nov 27, 2024
Closed
AlexWaygood pushed a commit that referenced this issue Nov 27, 2024
@javert42
gh-126882: Fix indentation in code sample block (#126887)
14a05a8
@github-actions github-actions bot mentioned this issue Dec 1, 2024
Closed
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
@javert42 @ebonnal
pythongh-126882: Fix indentation in code sample block (python#126887)
75fb115
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy
Projects
docs issues
Status: Todo
Milestone
No milestone
Development

No branches or pull requests
4 participants
@javert42 @tomasr8 @AlexWaygood @bhagwant4040