diff options
| author | Éric Araujo <merwok@netwok.org> | 2010-11-18 16:38:46 (GMT) |
|---|---|---|
| committer | Éric Araujo <merwok@netwok.org> | 2010-11-18 16:38:46 (GMT) |
| commit | 713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5 (patch) | |
| tree | 99bdc854fa7a540ee5339de5a2a6888bdc7d003e /Doc/library/timeit.rst | |
| parent | daa29d01b749daa4843bcac80bd0067a827cfb8a (diff) | |
| download | cpython-713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5.zip cpython-713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5.tar.gz cpython-713d3039dc7d5b8e1a8fdd0f3517fa7053175ed5.tar.bz2 | |
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.
Diffstat (limited to 'Doc/library/timeit.rst')
| -rw-r--r-- | Doc/library/timeit.rst | 27 |
1 files changed, 18 insertions, 9 deletions
diff --git a/Doc/library/timeit.rst b/Doc/library/timeit.rst index 89ea7b0..4a0b9c2 100644 --- a/Doc/library/timeit.rst +++ b/Doc/library/timeit.rst @@ -117,27 +117,36 @@ When called as a program from the command line, the following form is used:: python -m timeit [-n N] [-r N] [-s S] [-t] [-c] [-h] [statement ...] -where the following options are understood: +Where the following options are understood: + +.. program:: timeit + +.. cmdoption:: -n N, --number=N --n N/:option:`--number=N` how many times to execute 'statement' --r N/:option:`--repeat=N` +.. cmdoption:: -r N, --repeat=N + how many times to repeat the timer (default 3) --s S/:option:`--setup=S` - statement to be executed once initially (default ``'pass'``) +.. cmdoption:: -s S, --setup=S + + statement to be executed once initially (default ``pass``) + +.. cmdoption:: -t, --time --t/:option:`--time` use :func:`time.time` (default on all platforms but Windows) --c/:option:`--clock` +.. cmdoption:: -c, --clock + use :func:`time.clock` (default on Windows) --v/:option:`--verbose` +.. cmdoption:: -v, --verbose + print raw timing results; repeat for more digits precision --h/:option:`--help` +.. cmdoption:: -h, --help + print a short usage message and exit A multi-line statement may be given by specifying each line as a separate |