[Python-checkins] cpython (merge 3.4 -> default): Merge several minor doc fixes from 3.4
zach.ware
python-checkins at python.org
Thu Mar 20 18:00:09 CET 2014
http://hg.python.org/cpython/rev/a7bf938bc1e3
changeset: 89886:a7bf938bc1e3
parent: 89880:2470f5d4e269
parent: 89884:3afa9116859c
user: Zachary Ware <zachary.ware at gmail.com>
date: Thu Mar 20 11:28:16 2014 -0500
summary:
Merge several minor doc fixes from 3.4
files:
Doc/distutils/apiref.rst | 2 +-
Doc/faq/extending.rst | 4 ++--
Doc/library/enum.rst | 6 +++---
Doc/library/os.rst | 4 ++--
Lib/os.py | 4 ++--
5 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/Doc/distutils/apiref.rst b/Doc/distutils/apiref.rst
--- a/Doc/distutils/apiref.rst
+++ b/Doc/distutils/apiref.rst
@@ -993,7 +993,7 @@
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
- <http://nfs.sourceforge.net/#section_d>`_.
+ <http://nfs.sourceforge.net/#section_d>`_).
.. versionchanged:: 3.3.1
NFS files are ignored.
diff --git a/Doc/faq/extending.rst b/Doc/faq/extending.rst
--- a/Doc/faq/extending.rst
+++ b/Doc/faq/extending.rst
@@ -95,8 +95,8 @@
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
details. It allows interfacing with any kind of Python sequence using calls
-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.
+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
al.) and mappings in the PyMapping APIs.
diff --git a/Doc/library/enum.rst b/Doc/library/enum.rst
--- a/Doc/library/enum.rst
+++ b/Doc/library/enum.rst
@@ -442,7 +442,7 @@
: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)::
'red green blue' | 'red,green,blue' | 'red, green, blue'
@@ -453,7 +453,7 @@
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.
@@ -543,7 +543,7 @@
add methods and don't specify another data type such as :class:`int` or
:class:`str`.
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.
4. %-style formatting: `%s` and `%r` call :class:`Enum`'s :meth:`__str__` and
:meth:`__repr__` respectively; other codes (such as `%i` or `%h` for
diff --git a/Doc/library/os.rst b/Doc/library/os.rst
--- a/Doc/library/os.rst
+++ b/Doc/library/os.rst
@@ -1607,7 +1607,7 @@
The *dir_fd* argument.
-.. function:: makedirs(path, mode=0o777, exist_ok=False)
+.. function:: makedirs(name, mode=0o777, exist_ok=False)
.. index::
single: directory; creating
@@ -1763,7 +1763,7 @@
The *dir_fd* argument.
-.. function:: removedirs(path)
+.. function:: removedirs(name)
.. index:: single: directory; deleting
diff --git a/Lib/os.py b/Lib/os.py
--- a/Lib/os.py
+++ b/Lib/os.py
@@ -216,7 +216,7 @@
# (Inspired by Eric Raymond; the doc strings are mostly his)
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.
Works like mkdir, except that any intermediate path segment (not
@@ -260,7 +260,7 @@
raise
def removedirs(name):
- """removedirs(path)
+ """removedirs(name)
Super-rmdir; remove a leaf directory and all empty intermediate
ones. Works like rmdir except that, if the leaf directory is
--
Repository URL: http://hg.python.org/cpython
More information about the Python-checkins
mailing list