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

Create memray.1 #523

Closed alexmyczko closed 7 months ago

alexmyczko commented 8 months ago

Issue number of the reported bug or feature request: #

Describe your changes add a manual page

Testing performed yes man ./memray.1

Additional context classical systems supply a printable manual to commands with options and their description

codecov-commenter commented 8 months ago

Codecov Report

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

Comparison is base (853df63) 92.44% compared to head (2fd3b46) 92.31%.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #523 +/- ## ========================================== - Coverage 92.44% 92.31% -0.13% ========================================== Files 91 91 Lines 11270 11270 Branches 1571 1571 ========================================== - Hits 10418 10404 -14 - Misses 847 861 +14 Partials 5 5 ``` | [Flag](https://app.codecov.io/gh/bloomberg/memray/pull/523/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/523/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `85.64% <ø> (-0.39%)` | :arrow_down: | | [python_and_cython](https://app.codecov.io/gh/bloomberg/memray/pull/523/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=bloomberg) | `95.53% <ø> (ø)` | | 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.

godlygeek commented 7 months ago

Closing this in favor of #524. Now that that has landed, make docs at the repo root should build a memray.1 man page.