-
-
Notifications
You must be signed in to change notification settings - Fork 31.9k
gh-115362: Add documentation to pystats output #115365
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
Conversation
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've wanted this so many times! All data presentation should have something like this. I take it it's not yet completed?
Yeah, I just wanted to wait until the content (faster-cpython/ideas#650) was done, which it (mostly) is now. |
This now uses An example full output is available here |
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.
Thanks @mdboom! The example output looks great to me now, on mobile and desktop. I left two optional suggestions below:
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.
LGTM, though you may want to apply Alex's suggestions. Thanks for doing this!
I've applied @AlexWaygood's suggestions. This is ready to merge, IMHO. Thanks for the review. |
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.
Thanks again! I'll enable auto-merge
This adds the better documentation for pystats being discussed on the ideas repo to the output of
summarize_stats.py
.Rather than having a separate document to cross-reference, it's easy enough to include the documentation inline in the output.
An example full output is available here