Skip to content

gh-117840: Fix indent to fix shlex syntax highlighting #117843

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 1 commit into from
Apr 13, 2024

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Apr 13, 2024

Fixes #117840.

Should be three-space indents: https://devguide.python.org/documentation/markup/#use-of-whitespace

The second block renders correctly with four, but let's make that consistent as well. The other code blocks use (multiples of) three.

Before

image

After

image

📚 Documentation preview 📚: https://cpython-previews--117843.org.readthedocs.build/en/117843/library/shlex.html#improved-compatibility-with-shells

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting core review labels Apr 13, 2024
@hugovk hugovk changed the title Fix indent to fix shlex syntax highlighting gh-117840: Fix indent to fix shlex syntax highlighting Apr 13, 2024
@hugovk hugovk added the needs backport to 3.12 only security fixes label Apr 13, 2024
@hugovk hugovk merged commit dd72423 into python:main Apr 13, 2024
32 checks passed
@hugovk hugovk deleted the docs-shlex-code-formatting branch April 13, 2024 11:31
@miss-islington-app
Copy link

Thanks @hugovk for the PR 🌮🎉.. I'm working now to backport this PR to: 3.12.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 13, 2024
@bedevere-app
Copy link

bedevere-app bot commented Apr 13, 2024

GH-117844 is a backport of this pull request to the 3.12 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Apr 13, 2024
hugovk added a commit that referenced this pull request Apr 13, 2024
diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Shlex docs: improper syntax highlighting in code snippet
2 participants