mirror of https://github.com/python/cpython
#16589: fix pprint signatures in the doc (backport of 106ee4eb5970).
This commit is contained in:
parent
4f3b5943a9
commit
63b04486f8
|
@ -36,7 +36,7 @@ The :mod:`pprint` module defines one class:
|
|||
.. First the implementation class:
|
||||
|
||||
|
||||
.. class:: PrettyPrinter(...)
|
||||
.. class:: PrettyPrinter(indent=1, width=80, depth=None, stream=None)
|
||||
|
||||
Construct a :class:`PrettyPrinter` instance. This constructor understands
|
||||
several keyword parameters. An output stream may be set using the *stream*
|
||||
|
@ -73,9 +73,7 @@ The :mod:`pprint` module defines one class:
|
|||
|
||||
The :class:`PrettyPrinter` class supports several derivative functions:
|
||||
|
||||
.. Now the derivative functions:
|
||||
|
||||
.. function:: pformat(object[, indent[, width[, depth]]])
|
||||
.. function:: pformat(object, indent=1, width=80, depth=None)
|
||||
|
||||
Return the formatted representation of *object* as a string. *indent*, *width*
|
||||
and *depth* will be passed to the :class:`PrettyPrinter` constructor as
|
||||
|
@ -85,10 +83,10 @@ The :class:`PrettyPrinter` class supports several derivative functions:
|
|||
The parameters *indent*, *width* and *depth* were added.
|
||||
|
||||
|
||||
.. function:: pprint(object[, stream[, indent[, width[, depth]]]])
|
||||
.. function:: pprint(object, stream=None, indent=1, width=80, depth=None)
|
||||
|
||||
Prints the formatted representation of *object* on *stream*, followed by a
|
||||
newline. If *stream* is omitted, ``sys.stdout`` is used. This may be used in
|
||||
newline. If *stream* is ``None``, ``sys.stdout`` is used. This may be used in
|
||||
the interactive interpreter instead of a :keyword:`print` statement for
|
||||
inspecting values. *indent*, *width* and *depth* will be passed to the
|
||||
:class:`PrettyPrinter` constructor as formatting parameters.
|
||||
|
@ -206,7 +204,8 @@ are converted to strings. The default implementation uses the internals of the
|
|||
pprint Example
|
||||
--------------
|
||||
|
||||
This example demonstrates several uses of the :func:`pprint` function and its parameters.
|
||||
This example demonstrates several uses of the :func:`pprint` function and its
|
||||
parameters.
|
||||
|
||||
>>> import pprint
|
||||
>>> tup = ('spam', ('eggs', ('lumberjack', ('knights', ('ni', ('dead',
|
||||
|
|
Loading…
Reference in New Issue