[Python-checkins] cpython (3.5): Fix grammar, typos and markup in documentation and code comments

[martin.panter]

https://hg.python.org/cpython/rev/2b2f890c481e
changeset:   106146:2b2f890c481e
branch:      3.5
parent:      106142:dd2c7d497878
user:        Martin Panter <vadmium+py at gmail.com>
date:        Sat Jan 14 08:23:08 2017 +0000
summary:
  Fix grammar, typos and markup in documentation and code comments

* Indent versionchanged at method level, not class level
* Mark up ``--help`` to avoid generating an en dash
* Use forward slash in Unix command line with a dollar sign ($) prompt

files:
  Doc/library/argparse.rst     |   4 ++--
  Doc/library/unittest.rst     |  10 +++++-----
  Misc/NEWS                    |   2 +-
  Modules/_collectionsmodule.c |   2 +-
  Modules/_io/textio.c         |   2 +-
  Objects/odictobject.c        |   2 +-
  6 files changed, 11 insertions(+), 11 deletions(-)


diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -174,7 +174,7 @@
    * conflict_handler_ - The strategy for resolving conflicting optionals
      (usually unnecessary)
 
-   * add_help_ - Add a -h/--help option to the parser (default: ``True``)
+   * add_help_ - Add a ``-h/--help`` option to the parser (default: ``True``)
 
    * allow_abbrev_ - Allows long options to be abbreviated if the
      abbreviation is unambiguous. (default: ``True``)
@@ -211,7 +211,7 @@
     -h, --help  show this help message and exit
     --foo FOO   foo help
    $ cd ..
-   $ python subdir\myprogram.py --help
+   $ python subdir/myprogram.py --help
    usage: myprogram.py [-h] [--foo FOO]
 
    optional arguments:
diff --git a/Doc/library/unittest.rst b/Doc/library/unittest.rst
--- a/Doc/library/unittest.rst
+++ b/Doc/library/unittest.rst
@@ -1637,11 +1637,11 @@
 
       The method optionally resolves *name* relative to the given *module*.
 
-   .. versionchanged:: 3.5
-      If an :exc:`ImportError` or :exc:`AttributeError` occurs while traversing
-      *name* then a synthetic test that raises that error when run will be
-      returned. These errors are included in the errors accumulated by
-      self.errors.
+      .. versionchanged:: 3.5
+         If an :exc:`ImportError` or :exc:`AttributeError` occurs while traversing
+         *name* then a synthetic test that raises that error when run will be
+         returned. These errors are included in the errors accumulated by
+         self.errors.
 
 
    .. method:: loadTestsFromNames(names, module=None)
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -189,7 +189,7 @@
   WeakValueDictionary.pop() when a GC collection happens in another
   thread.
 
-- Issue #20191: Fixed a crash in resource.prlimit() when pass a sequence that
+- Issue #20191: Fixed a crash in resource.prlimit() when passing a sequence that
   doesn't own its elements as limits.
 
 - Issue #28779: multiprocessing.set_forkserver_preload() would crash the
diff --git a/Modules/_collectionsmodule.c b/Modules/_collectionsmodule.c
--- a/Modules/_collectionsmodule.c
+++ b/Modules/_collectionsmodule.c
@@ -2169,7 +2169,7 @@
 PyDoc_STRVAR(_count_elements_doc,
 "_count_elements(mapping, iterable) -> None\n\
 \n\
-Count elements in the iterable, updating the mappping");
+Count elements in the iterable, updating the mapping");
 
 static PyObject *
 _count_elements(PyObject *self, PyObject *args)
diff --git a/Modules/_io/textio.c b/Modules/_io/textio.c
--- a/Modules/_io/textio.c
+++ b/Modules/_io/textio.c
@@ -1012,7 +1012,7 @@
                                                            errors);
         if (self->encoder == NULL)
             goto error;
-        /* Get the normalized named of the codec */
+        /* Get the normalized name of the codec */
         res = _PyObject_GetAttrId(codec_info, &PyId_name);
         if (res == NULL) {
             if (PyErr_ExceptionMatches(PyExc_AttributeError))
diff --git a/Objects/odictobject.c b/Objects/odictobject.c
--- a/Objects/odictobject.c
+++ b/Objects/odictobject.c
@@ -2237,7 +2237,7 @@
 
 
 /* ----------------------------------------------
-   MutableMappping implementations
+   MutableMapping implementations
 
 Mapping:
 

-- 
Repository URL: https://hg.python.org/cpython