mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 18:59:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

Merge several minor doc fixes from 3.4

Browse source
This commit is contained in:
Zachary Ware 2014-03-20 11:28:16 -05:00
commit 9636e98b18
5 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

2
Doc/distutils/apiref.rst
View file

@ -993,7 +993,7 @@ directories.
Files in *src* that begin with :file:`.nfs` are skipped (more information on Files in *src* that begin with :file:`.nfs` are skipped (more information on
these files is available in answer D2 of the `NFS FAQ page these files is available in answer D2 of the `NFS FAQ page
<http://nfs.sourceforge.net/#section_d>`_. <http://nfs.sourceforge.net/#section_d>`_).
.. versionchanged:: 3.3.1 .. versionchanged:: 3.3.1
NFS files are ignored. NFS files are ignored.

4
Doc/faq/extending.rst
View file

@ -95,8 +95,8 @@ To test the type of an object, first make sure it isn't *NULL*, and then use
There is also a high-level API to Python objects which is provided by the There is also a high-level API to Python objects which is provided by the
so-called 'abstract' interface -- read ``Include/abstract.h`` for further so-called 'abstract' interface -- read ``Include/abstract.h`` for further
details. It allows interfacing with any kind of Python sequence using calls details. It allows interfacing with any kind of Python sequence using calls
like :c:func:`PySequence_Length`, :c:func:`PySequence_GetItem`, etc.) as well like :c:func:`PySequence_Length`, :c:func:`PySequence_GetItem`, etc. as well
as many other useful protocols such as numbers (:c:func:`PyNumber_Index` et. as many other useful protocols such as numbers (:c:func:`PyNumber_Index` et
al.) and mappings in the PyMapping APIs. al.) and mappings in the PyMapping APIs.

6
Doc/library/enum.rst
View file

@ -442,7 +442,7 @@ The complete signature is::
:value: What the new Enum class will record as its name. :value: What the new Enum class will record as its name.
:names: The Enum members. This can be a whitespace or comma seperated string :names: The Enum members. This can be a whitespace or comma separated string
(values will start at 1):: (values will start at 1)::
'red green blue' | 'red,green,blue' | 'red, green, blue' 'red green blue' | 'red,green,blue' | 'red, green, blue'
@ -453,7 +453,7 @@ The complete signature is::
or a mapping:: or a mapping::
{'chartruese': 7, 'sea_green': 11, 'rosemary': 42} {'chartreuse': 7, 'sea_green': 11, 'rosemary': 42}
:module: name of module where new Enum class can be found. :module: name of module where new Enum class can be found.
@ -543,7 +543,7 @@ Some rules:
add methods and don't specify another data type such as :class:`int` or add methods and don't specify another data type such as :class:`int` or
:class:`str`. :class:`str`.
3. When another data type is mixed in, the :attr:`value` attribute is *not the 3. When another data type is mixed in, the :attr:`value` attribute is *not the
same* as the enum member itself, although it is equivalant and will compare same* as the enum member itself, although it is equivalent and will compare
equal. equal.
4. %-style formatting: `%s` and `%r` call :class:`Enum`'s :meth:`__str__` and 4. %-style formatting: `%s` and `%r` call :class:`Enum`'s :meth:`__str__` and
:meth:`__repr__` respectively; other codes (such as `%i` or `%h` for :meth:`__repr__` respectively; other codes (such as `%i` or `%h` for

4
Doc/library/os.rst
View file

@ -1607,7 +1607,7 @@ features:
The *dir_fd* argument. The *dir_fd* argument.
.. function:: makedirs(path, mode=0o777, exist_ok=False) .. function:: makedirs(name, mode=0o777, exist_ok=False)
.. index:: .. index::
single: directory; creating single: directory; creating
@ -1763,7 +1763,7 @@ features:
The *dir_fd* argument. The *dir_fd* argument.
.. function:: removedirs(path) .. function:: removedirs(name)
.. index:: single: directory; deleting .. index:: single: directory; deleting

4
Lib/os.py
View file

@ -216,7 +216,7 @@ def _get_masked_mode(mode):
# (Inspired by Eric Raymond; the doc strings are mostly his) # (Inspired by Eric Raymond; the doc strings are mostly his)
def makedirs(name, mode=0o777, exist_ok=False): def makedirs(name, mode=0o777, exist_ok=False):
"""makedirs(path [, mode=0o777][, exist_ok=False]) """makedirs(name [, mode=0o777][, exist_ok=False])
Super-mkdir; create a leaf directory and all intermediate ones. Super-mkdir; create a leaf directory and all intermediate ones.
Works like mkdir, except that any intermediate path segment (not Works like mkdir, except that any intermediate path segment (not
@ -260,7 +260,7 @@ def makedirs(name, mode=0o777, exist_ok=False):
raise raise
def removedirs(name): def removedirs(name):
"""removedirs(path) """removedirs(name)
Super-rmdir; remove a leaf directory and all empty intermediate Super-rmdir; remove a leaf directory and all empty intermediate
ones. Works like rmdir except that, if the leaf directory is ones. Works like rmdir except that, if the leaf directory is