bloomberg / memray

Memray is a memory profiler for Python
https://bloomberg.github.io/memray/
Apache License 2.0
13.36k stars 397 forks source link

docs: Updates to Memray tutorials #607

Closed drz416 closed 5 months ago

drz416 commented 5 months ago

Updates to memray tutorial docs.

Issue number of the reported bug or feature request: not related to an issue

Describe your changes Updated the 3 tutorial examples throughout by adding more code examples, adding more explainer text, and fixed typos. No additional examples added.

Testing performed I've run the tutorial tests provided that continue to work. There were no code changes impacting tests.

Additional context No additional context

codecov-commenter commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 92.81%. Comparing base (41248ed) to head (a31166f). Report is 55 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #607 +/- ## ========================================== + Coverage 92.55% 92.81% +0.26% ========================================== Files 91 92 +1 Lines 11304 11234 -70 Branches 1581 2055 +474 ========================================== - Hits 10462 10427 -35 + Misses 837 807 -30 + Partials 5 0 -5 ``` | [Flag](https://app.codecov.io/gh/bloomberg/memray/pull/607/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | Coverage Δ | | |---|---|---| | [cpp](https://app.codecov.io/gh/bloomberg/memray/pull/607/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `92.81% <ø> (+6.87%)` | :arrow_up: | | [python_and_cython](https://app.codecov.io/gh/bloomberg/memray/pull/607/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `92.81% <ø> (-2.91%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

drz416 commented 5 months ago

Can you please check the

image

checkbox at the bottom of the right sidebar, just below

image

I'd like to make some edits to your commit. I agree with about 90% of it, but I want to change a few things, and I don't currently have permission to make those changes.

oops, should work now. Thanks!