Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 7f01a13

Browse files
birkenfeldbirkenfeld
committed
Last round of adapting style of documenting argument default values.
1 parent fe99105 commit 7f01a13

59 files changed

Lines changed: 522 additions & 567 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Doc/library/someos.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
.. _someos:
32

43
**********************************
@@ -8,7 +7,7 @@ Optional Operating System Services
87
The modules described in this chapter provide interfaces to operating system
98
features that are available on selected operating systems only. The interfaces
109
are generally modeled after the Unix or C interfaces but they are available on
11-
some other systems as well (e.g. Windows or NT). Here's an overview:
10+
some other systems as well (e.g. Windows). Here's an overview:
1211

1312

1413
.. toctree::

‎Doc/library/spwd.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
:mod:`spwd` --- The shadow password database
32
============================================
43

@@ -48,7 +47,7 @@ below, see ``<shadow.h>``):
4847
The sp_nam and sp_pwd items are strings, all others are integers.
4948
:exc:`KeyError` is raised if the entry asked for cannot be found.
5049

51-
It defines the following items:
50+
The following functions are defined:
5251

5352

5453
.. function:: getspnam(name)

‎Doc/library/ssl.rst‎

Lines changed: 261 additions & 275 deletions
Large diffs are not rendered by default.

‎Doc/library/stat.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
21
:mod:`stat` --- Interpreting :func:`stat` results
32
=================================================
43

54
.. module:: stat
6-
:synopsis: Utilities for interpreting the results of os.stat(), os.lstat() and os.fstat().
5+
:synopsis: Utilities for interpreting the results of os.stat(),
6+
os.lstat() and os.fstat().
77
.. sectionauthor:: Skip Montanaro <[email protected]>
88

99

‎Doc/library/string.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -479,19 +479,19 @@ these rules. The methods of :class:`Template` are:
479479
The constructor takes a single argument which is the template string.
480480

481481

482-
.. method:: substitute(mapping[, **kws])
482+
.. method:: substitute(mapping, **kwds)
483483

484484
Performs the template substitution, returning a new string. *mapping* is
485485
any dictionary-like object with keys that match the placeholders in the
486486
template. Alternatively, you can provide keyword arguments, where the
487-
keywords are the placeholders. When both *mapping* and *kws* are given
488-
and there are duplicates, the placeholders from *kws* take precedence.
487+
keywords are the placeholders. When both *mapping* and *kwds* are given
488+
and there are duplicates, the placeholders from *kwds* take precedence.
489489

490490

491-
.. method:: safe_substitute(mapping[, **kws])
491+
.. method:: safe_substitute(mapping, **kwds)
492492

493493
Like :meth:`substitute`, except that if placeholders are missing from
494-
*mapping* and *kws*, instead of raising a :exc:`KeyError` exception, the
494+
*mapping* and *kwds*, instead of raising a :exc:`KeyError` exception, the
495495
original placeholder will appear in the resulting string intact. Also,
496496
unlike with :meth:`substitute`, any other appearances of the ``$`` will
497497
simply return ``$`` instead of raising :exc:`ValueError`.

‎Doc/library/stringprep.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
:mod:`stringprep` --- Internet String Preparation
32
=================================================
43

‎Doc/library/strings.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
.. _stringservices:
32

43
***************

‎Doc/library/struct.rst‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
1-
21
:mod:`struct` --- Interpret bytes as packed binary data
3-
=========================================================
2+
=======================================================
43

54
.. module:: struct
65
:synopsis: Interpret bytes as packed binary data.
@@ -46,7 +45,7 @@ The module defines the following exception and functions:
4645
(``len(bytes)`` must equal ``calcsize(fmt)``).
4746

4847

49-
.. function:: unpack_from(fmt, buffer[,offset=0])
48+
.. function:: unpack_from(fmt, buffer, offset=0)
5049

5150
Unpack the *buffer* according to the given format. The result is a tuple even
5251
if it contains exactly one item. The *buffer* must contain at least the amount
@@ -286,7 +285,7 @@ The :mod:`struct` module also defines the following type:
286285
(``len(bytes)`` must equal :attr:`self.size`).
287286

288287

289-
.. method:: unpack_from(buffer[, offset=0])
288+
.. method:: unpack_from(buffer, offset=0)
290289

291290
Identical to the :func:`unpack_from` function, using the compiled format.
292291
(``len(buffer[offset:])`` must be at least :attr:`self.size`).

‎Doc/library/subprocess.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
:mod:`subprocess` --- Subprocess management
32
===========================================
43

@@ -121,9 +120,10 @@ This module defines one class called :class:`Popen`:
121120

122121
.. note::
123122

124-
This feature is only available if Python is built with universal newline support
125-
(the default). Also, the newlines attribute of the file objects :attr:`stdout`,
126-
:attr:`stdin` and :attr:`stderr` are not updated by the :meth:`communicate` method.
123+
This feature is only available if Python is built with universal newline
124+
support (the default). Also, the newlines attribute of the file objects
125+
:attr:`stdout`, :attr:`stdin` and :attr:`stderr` are not updated by the
126+
:meth:`communicate` method.
127127

128128
The *startupinfo* and *creationflags*, if given, will be passed to the
129129
underlying CreateProcess() function. They can specify things such as appearance

‎Doc/library/sunau.rst‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
21
:mod:`sunau` --- Read and write Sun AU files
32
============================================
43

0 commit comments

Comments
 (0)