8000 GH-115986 Fix `pprint` documentation by Privat33r-dev · Pull Request #116019 · python/cpython · GitHub
[go: up one dir, main page]
Skip to content

GH-115986 Fix pprint documentation #116019

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.

Sign up for GitHub

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 10 commits into from
Feb 28, 2024
Merged

GH-115986 Fix pprint documentation #116019

Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
ff430ea
GH-115986 Doc: change 'pprint' module documentation's structure
Privat33r-dev Feb 28, 2024
7f5be79
Doc: fix links in 'pprint' documentation
Privat33r-dev Feb 28, 2024
7001ac5
Add warning to use 'pp' instead of 'pprint'
Privat33r-dev Feb 28, 2024
9f7e077
Fix typo
Privat33r-dev Feb 28, 2024
a9298cd
Add prefix to 'pprint.pprint' references
Privat33r-dev Feb 28, 2024
6f4cf93
Improve formatting for sys.stdout
Privat33r-dev Feb 28, 2024
65d20b5
Improve 'pprint.pp' formatting
Privat33r-dev Feb 28, 2024
f126b36
Remove references from other than first occurences of sys.stdout
Privat33r-dev Feb 28, 2024
b7f656e
Remove mention that pprint.pprint is unintuitive
Privat33r-dev Feb 28, 2024
e9aa1d2
Minor clean up
Privat33r-dev Feb 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add prefix to 'pprint.pprint' references
  • Loading branch information
@Privat33r-dev
Privat33r-dev committed Feb 28, 2024
commit a9298cd0fabf0e041bc3ca9f4e027ac6aec78ae4
6 changes: 3 additions & 3 deletions Doc/library/pprint.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Functions
Prints the formatted representation of *object* followed by a newline.
If *sort_dicts* is false (the default), dictionaries will be displayed with
their keys in insertion order, otherwise the dict keys will be sorted.
*args* and *kwargs* will be passed to :func:`pprint.pprint` as formatting
*args* and *kwargs* will be passed to :func:`~pprint.pprint` as formatting
parameters.

.. versionadded:: 3.8
Expand Down Expand Up @@ -267,7 +267,7 @@ are converted to strings. The default implementation uses the internals of the
Example
-------

To demonstrate several uses of the :func:`pprint.pprint` function and its parameters,
To demonstrate several uses of the :func:`~pprint.pprint` function and its parameters,
let's fetch information about a project from `PyPI <https://pypi.org>`_::

>>> import json
Expand All @@ -276,7 +276,7 @@ let's fetch information about a project from `PyPI <https://pypi.org>`_::
>>> with urlopen('https://pypi.org/pypi/sampleproject/json') as resp:
... project_info = json.load(resp)['info']

In its basic form, :func:`pprint.pprint` shows the whole object::
In its basic form, :func:`~pprint.pprint` shows the whole object::

>>> pprint.pprint(project_info)
{'author': 'The Python Packaging Authority',
Expand Down
0