diff options
author | Éric Araujo <merwok@netwok.org> | 2010-12-16 03:53:53 (GMT) |
---|---|---|
committer | Éric Araujo <merwok@netwok.org> | 2010-12-16 03:53:53 (GMT) |
commit | a8132ec27efc5b1f136db38d819c7ecc389b90f4 (patch) | |
tree | 16c960282d4d96865308680d7b88511da6439e8a /Doc/library/doctest.rst | |
parent | 0f39690dc49781037f9523c456878ee0756744de (diff) | |
download | cpython-a8132ec27efc5b1f136db38d819c7ecc389b90f4.zip cpython-a8132ec27efc5b1f136db38d819c7ecc389b90f4.tar.gz cpython-a8132ec27efc5b1f136db38d819c7ecc389b90f4.tar.bz2 |
Merged revisions 86521,86632,86823-86824,87294,87296,87300,87302 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r86521 | eric.araujo | 2010-11-18 17:38:46 +0100 (jeu., 18 nov. 2010) | 17 lines
Fix usage of :option: in the docs (#9312).
:option: is used to create a link to an option of python, not to mark
up any instance of any arbitrary command-line option. These were
changed to ````.
For modules which do have a command-line interface, lists of options
have been properly marked up with the program/cmdoption directives
combo. Options defined in such blocks can be linked to with :option:
later in the same file, they won’t link to an option of python.
Finally, the markup of command-line fragments in optparse.rst has
been cleaned to use ``x`` instead of ``"x"``, keeping that latter
form for actual Python strings.
Patch by Eli Bendersky and Éric Araujo.
........
r86632 | eric.araujo | 2010-11-21 04:09:17 +0100 (dim., 21 nov. 2010) | 2 lines
Style edits in followup to r86521 (#9312)
........
r86823 | eric.araujo | 2010-11-27 00:31:07 +0100 (sam., 27 nov. 2010) | 2 lines
Use link-generating markup (see #9312)
........
r86824 | eric.araujo | 2010-11-27 00:46:18 +0100 (sam., 27 nov. 2010) | 2 lines
Rewrap long lines + minor edits
........
r87294 | eric.araujo | 2010-12-16 01:07:01 +0100 (jeu., 16 déc. 2010) | 2 lines
No need to generate a link for something that’s just above.
........
r87296 | eric.araujo | 2010-12-16 01:23:30 +0100 (jeu., 16 déc. 2010) | 2 lines
Advertise “python -m” instead of direct filename.
........
r87300 | eric.araujo | 2010-12-16 02:40:26 +0100 (jeu., 16 déc. 2010) | 2 lines
Advertise “python -m test” over test.regrtest (r87296 followup)
........
r87302 | eric.araujo | 2010-12-16 03:10:11 +0100 (jeu., 16 déc. 2010) | 2 lines
Add versionadded directive missing from r78983.
........
Diffstat (limited to 'Doc/library/doctest.rst')
-rw-r--r-- | Doc/library/doctest.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/Doc/library/doctest.rst b/Doc/library/doctest.rst index 5ca38c4..00012ea 100644 --- a/Doc/library/doctest.rst +++ b/Doc/library/doctest.rst @@ -95,7 +95,7 @@ works its magic:: $ There's no output! That's normal, and it means all the examples worked. Pass -:option:`-v` to the script, and :mod:`doctest` prints a detailed log of what +``-v`` to the script, and :mod:`doctest` prints a detailed log of what it's trying, and prints a summary at the end:: $ python example.py -v @@ -163,7 +163,7 @@ example(s) and the cause(s) of the failure(s) are printed to stdout, and the final line of output is ``***Test Failed*** N failures.``, where *N* is the number of examples that failed. -Run it with the :option:`-v` switch instead:: +Run it with the ``-v`` switch instead:: python M.py -v @@ -172,7 +172,7 @@ with assorted summaries at the end. You can force verbose mode by passing ``verbose=True`` to :func:`testmod`, or prohibit it by passing ``verbose=False``. In either of those cases, -``sys.argv`` is not examined by :func:`testmod` (so passing :option:`-v` or not +``sys.argv`` is not examined by :func:`testmod` (so passing ``-v`` or not has no effect). Since Python 2.6, there is also a command line shortcut for running @@ -242,7 +242,7 @@ See section :ref:`doctest-basic-api` for a description of the optional arguments that can be used to tell it to look for files in other locations. Like :func:`testmod`, :func:`testfile`'s verbosity can be set with the -:option:`-v` command-line switch or with the optional keyword argument +``-v`` command-line switch or with the optional keyword argument *verbose*. Since Python 2.6, there is also a command line shortcut for running @@ -1453,7 +1453,7 @@ DocTestRunner objects verbosity. If *verbose* is ``True``, then information is printed about each example, as it is run. If *verbose* is ``False``, then only failures are printed. If *verbose* is unspecified, or ``None``, then verbose output is used - iff the command-line switch :option:`-v` is used. + iff the command-line switch ``-v`` is used. The optional keyword argument *optionflags* can be used to control how the test runner compares expected output to actual output, and how it displays failures. |