Skip to content

gh-128998: Fix indentation of numbered list and literal block #128999

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 3 commits into from
Jan 18, 2025

Conversation

rffontenelle
Copy link
Contributor

@rffontenelle rffontenelle commented Jan 18, 2025

Fixes bad indentation in numbered list and adds one missing whitespace in literal block, to fix translated documentation generation.

The lack of indentation was turning these (supposed-to-be) numbered list items into simple paragraphs. While no error message pops up in English docs, building translation docs will emit:

faq/programming.rst:1912:<translated>:3: WARNING: Literal block expected; none found. [docutils]

Fixing indentation was enough, though. Now, translated build will emit:

faq/programming.rst:1926: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]

Adding one extra whitespace to the literal block (to make four-whitespaces indentation, instead of three) solves the whole thing

In the left is today's faq/programming.html, in right is my patch:


📚 Documentation preview 📚: https://cpython-previews--128999.org.readthedocs.build/

@AA-Turner AA-Turner enabled auto-merge (squash) January 18, 2025 20:47
@AA-Turner AA-Turner added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Jan 18, 2025
@AA-Turner AA-Turner merged commit e8092e5 into python:main Jan 18, 2025
29 checks passed
@miss-islington-app
Copy link

Thanks @rffontenelle for the PR, and @AA-Turner for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 18, 2025
…ythonGH-128999)

(cherry picked from commit e8092e5)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Jan 18, 2025

GH-129000 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jan 18, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jan 18, 2025
…ythonGH-128999)

(cherry picked from commit e8092e5)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Jan 18, 2025

GH-129001 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 Jan 18, 2025
@rffontenelle rffontenelle deleted the patch-10 branch January 18, 2025 20:54
AA-Turner added a commit that referenced this pull request Jan 18, 2025
…H-128999) (#129000)

gh-128998: Fix indentation of numbered list and literal block (GH-128999)
(cherry picked from commit e8092e5)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
AA-Turner added a commit that referenced this pull request Jan 18, 2025
…H-128999) (#129001)

gh-128998: Fix indentation of numbered list and literal block (GH-128999)
(cherry picked from commit e8092e5)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
srinivasreddy pushed a commit to srinivasreddy/cpython that referenced this pull request Jan 21, 2025
…ython#128999)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
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
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants