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 — [3.12] gh-115986 Improve pprint docs formatting (GH-117401) by miss-islington · Pull Request #121099 · python/cpython

Conversation

@miss-islington

@miss-islington miss-islington commented Jun 27, 2024 •
edited by github-actions Bot
Loading

Uh oh!

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

Copy link
Copy Markdown
Contributor
  • 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 [email protected]
Co-authored-by: Hugo van Kemenade [email protected]

  • Issue: Improve documentation for pprint module #115986

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

Sorry, something went wrong.

Uh oh!

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

All reactions
@Privat33r-dev @hugovk @miss-islington
pythongh-115986 Improve pprint docs formatting (pythonGH-117401)
c9b62d9
* 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 <[email protected]>
Co-authored-by: Hugo van Kemenade <[email protected]>
@bedevere-app bedevere-app Bot mentioned this pull request Jun 27, 2024
Improve documentation for pprint module #115986
Closed
@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Jun 27, 2024
@bedevere-app bedevere-app Bot mentioned this pull request Jun 27, 2024
gh-115986 Improve pprint docs formatting #117401
Merged
@bedevere-app bedevere-app Bot added the awaiting review label Jun 27, 2024
@encukou
Merge branch '3.12' into backport-0890ad7-3.12
8aae600
@encukou
encukou merged commit 3a420de into python:3.12 Jun 28, 2024
@bedevere-app bedevere-app Bot removed the awaiting review label Jun 28, 2024
@miss-islington
miss-islington deleted the backport-0890ad7-3.12 branch January 2, 2026 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

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

Assignees

No one assigned

Labels

docs Documentation in the Doc dir skip news

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

@miss-islington @encukou @Privat33r-dev
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.