diff options
| author | Matthias Bussonnier <bussonniermatthias@gmail.com> | 2017-02-21 05:30:00 (GMT) |
|---|---|---|
| committer | Berker Peksag <berker.peksag@gmail.com> | 2017-02-21 05:30:00 (GMT) |
| commit | 8fb1f6e039cbdeb333d83b7a62f0f37af4ce6e02 (patch) | |
| tree | 79f1a82f1788277fe6ebefab715214fda0dde968 /Doc | |
| parent | 112ec38c15b388fe025ccb85369a584d218b1160 (diff) | |
| download | cpython-8fb1f6e039cbdeb333d83b7a62f0f37af4ce6e02.zip cpython-8fb1f6e039cbdeb333d83b7a62f0f37af4ce6e02.tar.gz cpython-8fb1f6e039cbdeb333d83b7a62f0f37af4ce6e02.tar.bz2 | |
bpo-29554: Improve docs for pstat module and profile. (#88)
Clarify that methods take a string which is interpreted as a regex,
not a regex object.
Also clarify what the old `-1`, `0`, `1` and `2` options were.
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/profile.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/profile.rst b/Doc/library/profile.rst index 959d9b9..bd67fe4 100644 --- a/Doc/library/profile.rst +++ b/Doc/library/profile.rst @@ -444,9 +444,10 @@ Analysis of the profiler data is done using the :class:`~pstats.Stats` class. significant entries. Initially, the list is taken to be the complete set of profiled functions. Each restriction is either an integer (to select a count of lines), or a decimal fraction between 0.0 and 1.0 inclusive (to - select a percentage of lines), or a regular expression (to pattern match - the standard name that is printed. If several restrictions are provided, - then they are applied sequentially. For example:: + select a percentage of lines), or a string that will interpreted as a + regular expression (to pattern match the standard name that is printed). + If several restrictions are provided, then they are applied sequentially. + For example:: print_stats(.1, 'foo:') |