Skip to content
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

[3.12] gh-115986 Improve pprint docs formatting (GH-117401) #121099

Merged
merged 2 commits into from
Jun 28, 2024

Conversation

miss-islington
Copy link
Contributor

@miss-islington miss-islington commented Jun 27, 2024

  • Move pprinter parameters description to the table

The change improves readability.
Suggested in the GHGH-116085 PR discussion.

  • Make pprint doc with params markup

  • Fix formatting
    Indentation of code blocks made them nested
    "Version changed" is better placed after the code block

  • Fix formatting for tests

  • fix code indentation for autotests

  • Fix identation for autotests

  • Remove duplication of the parameters' description

  • Rearrange parameters description in a correct order


(cherry picked from commit 0890ad7)

Co-authored-by: Kerim Kabirov the.privat33r+gh@pm.me
Co-authored-by: Hugo van Kemenade 1324225+hugovk@users.noreply.github.com


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

* Move pprinter parameters description to the table

The change improves readability.
Suggested in the GHGH-116085 PR discussion.

* Make pprint doc with params markup

* Fix formatting
Indentation of code blocks made them nested
"Version changed" is better placed after the code block

* Fix formatting for tests

* fix code indentation for autotests

* Fix identation for autotests

* Remove duplication of the parameters' description

* Rearrange parameters description in a correct order

---------

(cherry picked from commit 0890ad7)

Co-authored-by: Kerim Kabirov <the.privat33r+gh@pm.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
@encukou encukou merged commit 3a420de into python:3.12 Jun 28, 2024
21 checks passed
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.

3 participants