Mailing List Archive: Python: Bugs

[issue6696] Profile objects should be documented

Index | Next | Previous | View Threaded

report at bugs

May 10, 2012, 11:11 AM

Post #1 of 3 (48 views)
Permalink

[issue6696] Profile objects should be documented

Tom Pinckney <thomaspinckney3 [at] gmail> added the comment:

Looking at the current docs for 3.3, it looks like there are a bunch of other ways that the docs could be clarified:

1) Proper documentation of the complete profile.Profile() and cProfile.Profile() interfaces.

2) Adding other examples to the quick start section at the top for how to process the resulting stats without printing them to stdout or writing them to a file.

I'll take a stab at this.

----------
nosy: +thomaspinckney3

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue6696>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

May 10, 2012, 4:42 PM

Post #2 of 3 (40 views)
Permalink

[issue6696] Profile objects should be documented [In reply to]

Changes by Éric Araujo <merwok [at] netwok>:

----------
nosy: +eric.araujo
versions: +Python 2.7

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue6696>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

report at bugs

May 12, 2012, 3:25 PM

Post #3 of 3 (37 views)
Permalink

[issue6696] Profile objects should be documented [In reply to]

Tom Pinckney <thomaspinckney3 [at] gmail> added the comment:

I took a stab at updating the docs based on the current profiler source. See attached patch for a first draft.

This is my first doc patch so would appreciate any feedback on style and substance of my changes.

I tried to document more of the modules (for example the internal Profile object), logically arrange things a better better IMHO, and generally be more precise about what is happening.

----------
keywords: +patch
Added file: http://bugs.python.org/file25555/patch.diff

_______________________________________
Python tracker <report [at] bugs>
<http://bugs.python.org/issue6696>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe: http://mail.python.org/mailman/options/python-bugs-list/list-python-bugs%40lists.gossamer-threads.com

Index | Next | Previous | View Threaded

Interested in having your list archived? Contact Gossamer Threads