diff options
author | Martin Panter <vadmium+py@gmail.com> | 2016-04-16 04:59:38 (GMT) |
---|---|---|
committer | Martin Panter <vadmium+py@gmail.com> | 2016-04-16 04:59:38 (GMT) |
commit | 00ccacc8db8194f15d8af26b788ec36314b990d1 (patch) | |
tree | 98bf16d9eeb894fdcb464eed646d53b4d366bfe7 /Doc/whatsnew | |
parent | b4912b8ed367e540ee060fe912f841cc764fd293 (diff) | |
download | cpython-00ccacc8db8194f15d8af26b788ec36314b990d1.zip cpython-00ccacc8db8194f15d8af26b788ec36314b990d1.tar.gz cpython-00ccacc8db8194f15d8af26b788ec36314b990d1.tar.bz2 |
Issue #26638: Fix links to some CLI options and section headings
* Disable inappropriate links to Python interpreter options
* Correct link to CLI section in zipapp
* Make CLI section label in timeit less ambiguous
Diffstat (limited to 'Doc/whatsnew')
-rw-r--r-- | Doc/whatsnew/2.3.rst | 6 | ||||
-rw-r--r-- | Doc/whatsnew/2.4.rst | 4 | ||||
-rw-r--r-- | Doc/whatsnew/2.5.rst | 6 | ||||
-rw-r--r-- | Doc/whatsnew/2.7.rst | 8 |
4 files changed, 12 insertions, 12 deletions
diff --git a/Doc/whatsnew/2.3.rst b/Doc/whatsnew/2.3.rst index 3aac79c..6e33922 100644 --- a/Doc/whatsnew/2.3.rst +++ b/Doc/whatsnew/2.3.rst @@ -1057,7 +1057,7 @@ Here are all of the changes that Python 2.3 makes to the core Python language. * A new warning, :exc:`PendingDeprecationWarning` was added to indicate features which are in the process of being deprecated. The warning will *not* be printed by default. To check for use of features that will be deprecated in the future, - supply :option:`-Walways::PendingDeprecationWarning::` on the command line or + supply :option:`-Walways::PendingDeprecationWarning:: <-W>` on the command line or use :func:`warnings.filterwarnings`. * The process of deprecating string-based exceptions, as in ``raise "Error @@ -1734,7 +1734,7 @@ The optparse Module The :mod:`getopt` module provides simple parsing of command-line arguments. The new :mod:`optparse` module (originally named Optik) provides more elaborate command-line parsing that follows the Unix conventions, automatically creates -the output for :option:`--help`, and can perform different actions for different +the output for :option:`!--help`, and can perform different actions for different options. You start by creating an instance of :class:`OptionParser` and telling it what @@ -1973,7 +1973,7 @@ Some of the more notable changes are: the Python program as part of its execution. * The :file:`regrtest.py` script now provides a way to allow "all resources - except *foo*." A resource name passed to the :option:`-u` option can now be + except *foo*." A resource name passed to the :option:`!-u` option can now be prefixed with a hyphen (``'-'``) to mean "remove this resource." For example, the option '``-uall,-bsddb``' could be used to enable the use of all resources except ``bsddb``. diff --git a/Doc/whatsnew/2.4.rst b/Doc/whatsnew/2.4.rst index fada04e..a613a9f 100644 --- a/Doc/whatsnew/2.4.rst +++ b/Doc/whatsnew/2.4.rst @@ -1483,8 +1483,8 @@ Some of the changes to Python's build process and to the C API are: intended as an aid to people developing the Python core. Providing :option:`----enable-profiling` to the :program:`configure` script will let you profile the interpreter with :program:`gprof`, and providing the - :option:`----with-tsc` switch enables profiling using the Pentium's Time-Stamp- - Counter register. Note that the :option:`----with-tsc` switch is slightly + :option:`--with-tsc` switch enables profiling using the Pentium's Time-Stamp- + Counter register. Note that the :option:`--with-tsc` switch is slightly misnamed, because the profiling feature also works on the PowerPC platform, though that processor architecture doesn't call that register "the TSC register". (Contributed by Jeremy Hylton.) diff --git a/Doc/whatsnew/2.5.rst b/Doc/whatsnew/2.5.rst index cf5f9dc..29d61f2 100644 --- a/Doc/whatsnew/2.5.rst +++ b/Doc/whatsnew/2.5.rst @@ -1095,7 +1095,7 @@ Here are all of the changes that Python 2.5 makes to the core Python language. log all the paths searched. In Python 2.5, a new :exc:`ImportWarning` warning is triggered when an import would have picked up a directory as a package but no :file:`__init__.py` was found. This warning is silently ignored by default; - provide the :option:`-Wd` option when running the Python executable to display + provide the :option:`-Wd <-W>` option when running the Python executable to display the warning message. (Implemented by Thomas Wouters.) * The list of base classes in a class definition can now be empty. As an @@ -1126,7 +1126,7 @@ or ``exit()`` will now exit the interpreter as they expect. (Implemented by Georg Brandl.) The Python executable now accepts the standard long options :option:`--help` -and :option:`--version`; on Windows, it also accepts the :option:`/?` option +and :option:`--version`; on Windows, it also accepts the :option:`/? <-?>` option for displaying a help message. (Implemented by Georg Brandl.) .. ====================================================================== @@ -1640,7 +1640,7 @@ complete list of changes, or look through the SVN logs for all the details. * The :mod:`webbrowser` module received a number of enhancements. It's now usable as a script with ``python -m webbrowser``, taking a URL as the argument; there are a number of switches to control the behaviour (:option:`-n` for a new - browser window, :option:`-t` for a new tab). New module-level functions, + browser window, :option:`!-t` for a new tab). New module-level functions, :func:`open_new` and :func:`open_new_tab`, were added to support this. The module's :func:`open` function supports an additional feature, an *autoraise* parameter that signals whether to raise the open window when possible. A number diff --git a/Doc/whatsnew/2.7.rst b/Doc/whatsnew/2.7.rst index c185ffd..d42b842 100644 --- a/Doc/whatsnew/2.7.rst +++ b/Doc/whatsnew/2.7.rst @@ -1820,12 +1820,12 @@ Consult the :mod:`unittest` module documentation for more details. The :func:`~unittest.main` function supports some other new options: -* :option:`-b` or :option:`--buffer` will buffer the standard output +* :option:`-b <unittest -b>` or :option:`--buffer` will buffer the standard output and standard error streams during each test. If the test passes, any resulting output will be discarded; on failure, the buffered output will be displayed. -* :option:`-c` or :option:`--catch` will cause the control-C interrupt +* :option:`-c <unittest -c>` or :option:`--catch` will cause the control-C interrupt to be handled more gracefully. Instead of interrupting the test process immediately, the currently running test will be completed and then the partial results up to the interruption will be reported. @@ -1839,7 +1839,7 @@ The :func:`~unittest.main` function supports some other new options: :func:`~unittest.removeHandler` decorator that can be used to mark tests that should have the control-C handling disabled. -* :option:`-f` or :option:`--failfast` makes +* :option:`-f <unittest -f>` or :option:`--failfast` makes test execution stop immediately when a test fails instead of continuing to execute further tests. (Suggested by Cliff Dyer and implemented by Michael Foord; :issue:`8074`.) @@ -2381,7 +2381,7 @@ Other Changes and Fixes takes an integer specifying how many tests run in parallel. This allows reducing the total runtime on multi-core machines. This option is compatible with several other options, including the - :option:`-R` switch which is known to produce long runtimes. + :option:`!-R` switch which is known to produce long runtimes. (Added by Antoine Pitrou, :issue:`6152`.) This can also be used with a new :option:`-F` switch that runs selected tests in a loop until they fail. (Added by Antoine Pitrou; :issue:`7312`.) |