GH-115986 Fix `pprint` documentation#116019

Privat33r-dev · 2024-02-28T01:32:58Z

I decided to separate the solution in 2 PRs. One PR is for fixing positions, references and including information that pprint.pprint function is unintuitive. And the other one would include setting up pp as default.

At first I thought that message about pprint.pprint being unintuitive might be divisive/hard to write, but later I figured out that it's a small change and fits current PR. Examples with pprint.pp might be divisive though, so once this PR is accepted, another PR is going to be introduced with the change.

Issue: Improve documentation for pprint module #115986

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

Privat33r-dev · 2024-02-28T02:34:57Z

Sorry for assignments, git acted a bit funny, likely due to the fact the I pulled locally, but haven't updated repo on github, so it decided to include some other changes as part of the PR. Looks like it was resolved.

Ensure `pp` and `pprint` are positioned prominently at the top of the page.

Before links pointed out to the module `pprint` instead of the `pprint.pprint` function.

hugovk · 2024-02-28T10:10:53Z

Please don't force-push PRs, it can make things harder to review, and everything will be squash-merged at the end. Thanks!

https://devguide.python.org/getting-started/pull-request-lifecycle/

As `pprint` might have unintended consequences with dict sorting.

Privat33r-dev · 2024-02-28T11:10:20Z

Please don't force-push PRs, it can make things harder to review, and everything will be squash-merged at the end. Thanks!
https://devguide.python.org/getting-started/pull-request-lifecycle/

Thanks for the advice. Earlier I worked on projects with different workflow where rebase was a standard procedure.

erlend-aasland · 2024-02-28T16:56:55Z

I decided to separate the solution in 2 PRs [...]

Thanks; it is better to do multiple PRs of atomic changes, than one giant PR with lots of changes. This holds both for code and docs changes.

Doc/library/pprint.rst

@erlend-aasland

Suggested-by: @erlend-aasland

Doc/library/pprint.rst

erlend-aasland · 2024-02-28T17:28:33Z

One more thing: please do not mention GitHub accounts in commit messages (such as 6f4cf93); they turn up as notifications and thus end up as noise.

Privat33r-dev · 2024-02-28T17:29:57Z

One more thing: please do not mention GitHub accounts in commit messages (such as 6f4cf93); they turn up as notifications and thus end up as noise.

Should I rebase now or is it just for the future?

erlend-aasland · 2024-02-28T17:33:16Z

Should I rebase now or is it just for the future?

For the future. Also, do a git merge --no-ff main -m "Pull in main" instead of rebasing.

erlend-aasland

LGTM; thanks!

…GH-116019) Introduce a new subsubsection, 'Functions', for module level functions, and place it before the PrettyPrinter class reference. Also: - Fix pprint.pprint() references so they properly link to the module level function. - Add links to sys.stdout. (cherry picked from commit 6c1c94d) Co-authored-by: Kerim Kabirov <[email protected]>

bedevere-app · 2024-02-28T19:43:18Z

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

bedevere-app · 2024-02-28T20:04:35Z

GH-116064 is a backport of this pull request to the 3.11 branch.

…6019) (#116061) GH-115986 Reorder pprint docs and amend some references (GH-116019) Introduce a new subsubsection, 'Functions', for module level functions, and place it before the PrettyPrinter class reference. Also: - Fix pprint.pprint() references so they properly link to the module level function. - Add links to sys.stdout. (cherry picked from commit 6c1c94d) Co-authored-by: Kerim Kabirov <[email protected]>

…) (#116064) (cherry picked from commit 6c1c94d) Introduce a new subsubsection, 'Functions', for module level functions, and place it before the PrettyPrinter class reference. Also: - Fix pprint.pprint() references so they properly link to the module level function. - Add links to sys.stdout. Co-authored-by: Kerim Kabirov <[email protected]>

…#116019) Introduce a new subsubsection, 'Functions', for module level functions, and place it before the PrettyPrinter class reference. Also: - Fix pprint.pprint() references so they properly link to the module level function. - Add links to sys.stdout.

Amend wording after gh-116019 was merged.

Amend wording after pythongh-116019 was merged. (cherry picked from commit e205c5c) Co-authored-by: Kerim Kabirov <[email protected]>

Amend wording after gh-116019 was merged. (cherry picked from commit e205c5c) Co-authored-by: Kerim Kabirov <[email protected]>

…#116019) Introduce a new subsubsection, 'Functions', for module level functions, and place it before the PrettyPrinter class reference. Also: - Fix pprint.pprint() references so they properly link to the module level function. - Add links to sys.stdout.

Amend wording after pythongh-116019 was merged.

…#116019) Introduce a new subsubsection, 'Functions', for module level functions, and place it before the PrettyPrinter class reference. Also: - Fix pprint.pprint() references so they properly link to the module level function. - Add links to sys.stdout.

Amend wording after pythongh-116019 was merged.

bedevere-appbot added the awaiting review label Feb 28, 2024

bedevere-appbot mentioned this pull request Feb 28, 2024
Improve documentation for pprint module #115986
Closed

bedevere-appbot added docs Documentation in the Doc dir skip news labels Feb 28, 2024

Privat33r-dev force-pushed the fix-docs-115986 branch 2 times, most recently from 36ff421 to 1745629Compare February 28, 2024 02:24

Privat33r-dev requested a review from isidentical as a code owner February 28, 2024 02:24

Privat33r-dev force-pushed the fix-docs-115986 branch from 1745629 to 70b93acCompare February 28, 2024 02:32

Privat33r-dev force-pushed the fix-docs-115986 branch from 70b93ac to 935b04aCompare February 28, 2024 09:53

Privat33r-dev added 2 commits February 28, 2024 10:58

pythonGH-115986Doc: change 'pprint' module documentation's structure
ff430ea
Ensure `pp` and `pprint` are positioned prominently at the top of the page.

Doc: fix links in 'pprint' documentation
7f5be79
Before links pointed out to the module `pprint` instead of the `pprint.pprint` function.

Privat33r-dev force-pushed the fix-docs-115986 branch from 935b04a to 7f5be79Compare February 28, 2024 09:59

hugovk removed the request for review from isidentical February 28, 2024 10:10

Privat33r-dev added 2 commits February 28, 2024 12:04

Add warning to use 'pp' instead of 'pprint'
7001ac5
As `pprint` might have unintended consequences with dict sorting.

Fix typo
9f7e077

erlend-aasland reviewed Feb 28, 2024
View reviewed changes

Doc/library/pprint.rst Outdated Show resolvedHide resolved
Doc/library/pprint.rst Outdated Show resolvedHide resolved
Doc/library/pprint.rst Outdated Show resolvedHide resolved

Privat33r-dev added 3 commits February 28, 2024 18:13

Add prefix to 'pprint.pprint' references
a9298cd

Improve formatting for sys.stdout
6f4cf93
Suggested-by: @erlend-aasland

Improve 'pprint.pp' formatting
65d20b5

erlend-aasland reviewed Feb 28, 2024
View reviewed changes

Doc/library/pprint.rst Outdated Show resolvedHide resolved

Remove references from other than first occurences of sys.stdout
f126b36

erlend-aasland previously approved these changes Feb 28, 2024
View reviewed changes

bedevere-appbot removed the awaiting review label Feb 28, 2024

bedevere-appbot added awaiting merge and removed awaiting review labels Feb 28, 2024

erlend-aasland added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Feb 28, 2024

erlend-aasland merged commit 6c1c94d into python:mainFeb 28, 2024

This comment was marked as outdated.
Sign in to view

bedevere-appbot removed the awaiting merge label Feb 28, 2024

This comment was marked as outdated.
Sign in to view

miss-islington-appbot assigned erlend-aasland Feb 28, 2024

bedevere-appbot removed the needs backport to 3.12 only security fixes label Feb 28, 2024

bedevere-appbot removed the needs backport to 3.11 only security fixes label Feb 28, 2024

Privat33r-dev deleted the fix-docs-115986 branch February 29, 2024 09:02

Privat33r-dev mentioned this pull request Feb 29, 2024
gh-115986: Fix inaccuracies in pprint docs #116104
Merged

erlend-aasland pushed a commit that referenced this pull request Mar 5, 2024
gh-115986: Fix inaccuracies in pprint docs (#116104)
e205c5c
Amend wording after gh-116019 was merged.

This was referenced Mar 5, 2024
[3.12] gh-115986: Fix inaccuracies in pprint docs (GH-116104) #116382
Merged
[3.11] gh-115986: Fix inaccuracies in pprint docs (GH-116104) #116383
Merged

erlend-aasland pushed a commit that referenced this pull request Mar 5, 2024
[3.12]gh-115986: Fix inaccuracies in pprint docs (GH-116104) (#116382)
23a9ba4
Amend wording after gh-116019 was merged. (cherry picked from commit e205c5c) Co-authored-by: Kerim Kabirov <[email protected]>

erlend-aasland pushed a commit that referenced this pull request Mar 5, 2024
[3.11]gh-115986: Fix inaccuracies in pprint docs (GH-116104) (#116383)
8675e7f
Amend wording after gh-116019 was merged. (cherry picked from commit e205c5c) Co-authored-by: Kerim Kabirov <[email protected]>

adorilson pushed a commit to adorilson/cpython that referenced this pull request Mar 25, 2024
pythongh-115986: Fix inaccuracies in pprint docs (python#116104)
d2013fd
Amend wording after pythongh-116019 was merged.

diegorusso pushed a commit to diegorusso/cpython that referenced this pull request Apr 17, 2024
pythongh-115986: Fix inaccuracies in pprint docs (python#116104)
d31ac2f
Amend wording after pythongh-116019 was merged.

Uh oh!

GH-115986 Fix pprint documentation#116019

GH-115986 Fix pprint documentation #116019

Uh oh!

Conversation

Privat33r-dev commented Feb 28, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Privat33r-dev commented Feb 28, 2024

Uh oh!

hugovk commented Feb 28, 2024

Uh oh!

Privat33r-dev commented Feb 28, 2024

Uh oh!

erlend-aasland commented Feb 28, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

erlend-aasland commented Feb 28, 2024• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Privat33r-dev commented Feb 28, 2024

Uh oh!

erlend-aasland commented Feb 28, 2024

Uh oh!

erlend-aasland left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as outdated.

This comment was marked as outdated.

bedevere-appbot commented Feb 28, 2024

Uh oh!

bedevere-appbot commented Feb 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

GH-115986 Fix `pprint` documentation#116019

GH-115986 Fix `pprint` documentation #116019

Privat33r-dev commented Feb 28, 2024•
edited
Loading

erlend-aasland commented Feb 28, 2024•
edited
Loading