summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMartin Panter <vadmium+py@gmail.com>2017-01-14 08:51:49 (GMT)
committerMartin Panter <vadmium+py@gmail.com>2017-01-14 08:51:49 (GMT)
commitc7496ee6da5ed0feb69c8831bbae4172e20fe2d3 (patch)
treec53b4e25db08f52d1578594ebea8f7c08d3b19cf
parent43d84ea069658b62a5ce604b1f2e7ed90735c7b3 (diff)
downloadcpython-c7496ee6da5ed0feb69c8831bbae4172e20fe2d3.zip
cpython-c7496ee6da5ed0feb69c8831bbae4172e20fe2d3.tar.gz
cpython-c7496ee6da5ed0feb69c8831bbae4172e20fe2d3.tar.bz2
Fix spelling and markup in documentation and code comment
* Mark up ``--help`` to avoid generating an en dash * Use forward slash in Unix command line with a dollar sign ($) prompt
-rw-r--r--Doc/library/argparse.rst4
-rw-r--r--Modules/_io/textio.c2
2 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/argparse.rst b/Doc/library/argparse.rst
index 4ce6835..1ea1f3f 100644
--- a/Doc/library/argparse.rst
+++ b/Doc/library/argparse.rst
@@ -173,7 +173,7 @@ ArgumentParser objects
* 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``)
The following sections describe how each of these are used.
@@ -204,7 +204,7 @@ The help for this program will display ``myprogram.py`` as the program name
-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/Modules/_io/textio.c b/Modules/_io/textio.c
index b4007c2..f13dcb4 100644
--- a/Modules/_io/textio.c
+++ b/Modules/_io/textio.c
@@ -983,7 +983,7 @@ textiowrapper_init(textio *self, PyObject *args, PyObject *kwds)
errors);
if (self->encoder == NULL)
goto error;
- /* Get the normalized named of the codec */
+ /* Get the normalized name of the codec */
res = PyObject_GetAttrString(codec_info, "name");
if (res == NULL) {
if (PyErr_ExceptionMatches(PyExc_AttributeError))