search

bloomberg / memray

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

Miscellaneous improvements to our documentation and help messages #467

Closed godlygeek closed 1 year ago

godlygeek commented 1 year ago

Before adding a description= to our ArgumentParser's:

$ memray parse --help
usage: memray parse [-h] results

positional arguments:
  results     Results of the tracker run

options:
  -h, --help  show this help message and exit

Please submit feedback, ideas, and bug reports by filing a new issue at https://github.com/bloomberg/memray/issues

After:

$ memray parse --help
usage: memray parse [-h] results

Debug a results file by parsing and printing each record in it

positional arguments:
  results     Results of the tracker run

options:
  -h, --help  show this help message and exit

Please submit feedback, ideas, and bug reports by filing a new issue at https://github.com/bloomberg/memray/issues

Before setting COLUMNS in our docs/conf.py: image

After: image

codecov-commenter commented 1 year ago

Codecov Report

All modified lines are covered by tests :white_check_mark:

Comparison is base (c016ce5) 91.97% compared to head (c7f00a7) 91.94%. Report is 2 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #467 +/- ## ========================================== - Coverage 91.97% 91.94% -0.03% ========================================== Files 91 91 Lines 10803 10803 Branches 1485 1485 ========================================== - Hits 9936 9933 -3 - Misses 865 868 +3 Partials 2 2 ``` | [Flag](https://app.codecov.io/gh/bloomberg/memray/pull/467/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/467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `85.15% <ø> (-0.09%)` | :arrow_down: | | [python_and_cython](https://app.codecov.io/gh/bloomberg/memray/pull/467/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `95.41% <ø> (ø)` | | 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. | [Files](https://app.codecov.io/gh/bloomberg/memray/pull/467?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | Coverage Δ | | |---|---|---| | [src/memray/\_ipython/flamegraph.py](https://app.codecov.io/gh/bloomberg/memray/pull/467?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg#diff-c3JjL21lbXJheS9faXB5dGhvbi9mbGFtZWdyYXBoLnB5) | `95.45% <ø> (ø)` | | | [src/memray/commands/attach.py](https://app.codecov.io/gh/bloomberg/memray/pull/467?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg#diff-c3JjL21lbXJheS9jb21tYW5kcy9hdHRhY2gucHk=) | `59.17% <ø> (ø)` | | | [src/memray/commands/run.py](https://app.codecov.io/gh/bloomberg/memray/pull/467?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg#diff-c3JjL21lbXJheS9jb21tYW5kcy9ydW4ucHk=) | `89.10% <ø> (ø)` | | ... and [2 files with indirect coverage changes](https://app.codecov.io/gh/bloomberg/memray/pull/467/indirect-changes?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg)

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