-
-
Notifications
You must be signed in to change notification settings - Fork 31.1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
bpo-29554: Improve docs for pstat module and profile. #88
Conversation
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 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As the rewrapping make a lot of line changes:
or a string that will interpreted as a regular expression
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd recommend redoing the PR as a commit to make the change(s) you want and a commit to rewrap. That way the change can be reviewed more easily.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ohhhh ! Why did I never thought of that. Done.
Lib/pstats.py
Outdated
minor key of 'the name of the function'. Look at the two tables in | ||
sort_stats() and get_sort_arg_defs(self) for more examples. | ||
addition to the old -1, 0, 1, or 2 that are respectively interpreted as | ||
'stdname', 'calls', 'time', and 'cumulative'). It takes an arbitrary |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
add:
that are respectively interpreted as 'stdname', 'calls', 'time', and 'cumulative'
Lib/pstats.py
Outdated
number of quoted strings to select the sort order. For example | ||
sort_stats('time', 'name') sorts on the major key of 'internal function | ||
time', and on the minor key of 'the name of the function'. Look at the two | ||
tables in sort_stats() , get_sort_arg_defs(self) and sort_arg_dict_default |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
and
to ,
and add and sort_arg_dict_default
This requires a new tracker item on bugs.python.org. See step 5 at http://cpython-devguide.readthedocs.io/#quick-start for details. |
Thank you, I thought that was minor enough. but done as bpo-29554 |
Doc/library/profile.rst
Outdated
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Shouldn't "(to pattern match the standard name that is printed." be end with a closing parenthesis ?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes. Done.
Lib/pstats.py
Outdated
'name') sorts on the major key of 'internal function time', and on the | ||
minor key of 'the name of the function'. Look at the two tables in | ||
sort_stats() and get_sort_arg_defs(self) for more examples. | ||
addition to the old -1, 0, 1, or 2 that are respectively interpreted as |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are multiple whitespaces between "respectively interpreted".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good eyes !
Lib/pstats.py
Outdated
sort_stats() and get_sort_arg_defs(self) for more examples. | ||
addition to the old -1, 0, 1, or 2 that are respectively interpreted as | ||
'stdname', 'calls', 'time', and 'cumulative'). It takes an arbitrary number | ||
of quoted strings to select the sort order. For example sort_stats('time', |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Instead of breaking sort_stats('time', 'name')
call I'd move the "For example [...]" sentence to its own paragraph.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done as well.
Codecov Report
@@ Coverage Diff @@
## master #88 +/- ##
==========================================
- Coverage 83.38% 82.38% -1.01%
==========================================
Files 1367 1428 +61
Lines 344903 351138 +6235
==========================================
+ Hits 287604 289284 +1680
- Misses 57299 61854 +4555 Continue to review full report at Codecov.
|
Clarify that methods takes a string which is interpreted as a re, and not a re object. Clarify what the old `-1`, `0`, `1` and `2` option were.
Re wrap as a second commit, to make review easier.
Thanks! |
Thanks, much appreciated. |
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. (cherry picked from commit 8fb1f6e)
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. (cherry picked from commit 8fb1f6e)
stackless.current.switch() Fix an assertion violation caused by incorrect usage of ts->st.del_post_switch. Add a test case for "switch to current". This commit also adds the test class TestTaskletSwitching, which was only in 2.7-slp. https://bitbucket.org/stackless-dev/stackless/issues/88 (grafted from f0db3bdf1061, b85b07e9f10effdbf52adc71d452d1e93bd3c5fd, 782a1b292460 and 7d9b4398011f)
The object's thread-id may be zero by the time _Py_queue_object is called. Get the thread-id before marking the object as queued in _Py_DecRefShared. Fixes #88
Clarify that methods takes a string which is interpreted as a re, and
not a re object.
Clarify what the old
-1
,0
,1
and2
option were.bpo-29554