Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Clarify that reported allocations are at the high watermark #81

Merged
merged 2 commits into from
Jun 23, 2023
Merged

Clarify that reported allocations are at the high watermark #81

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
90df9ff
Update plugin.py
tdtshafer Jun 22, 2023
4508001
Update usage.rst
tdtshafer Jun 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/usage.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ pytest:
Allocation tracking
~~~~~~~~~~~~~~~~~~~

By default, the plugin will track allocations in all tests. This information is
By default, the plugin will track allocations at the high watermark in all tests. This information is
reported after tests run ends:

.. command-output:: env COLUMNS=92 pytest --memray demo
Expand Down
2 changes: 1 addition & 1 deletion src/pytest_memray/plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,7 +282,7 @@ def _report_records_for_test(
terminalreporter: TerminalReporter,
) -> None:
writeln = terminalreporter.write_line
writeln(f"Allocations results for {test_id}")
writeln(f"Allocation results for {test_id} at the high watermark")
writeln("")
writeln(f"\t 📦 Total memory allocated: {sizeof_fmt(metadata.peak_memory)}")
writeln(f"\t 📏 Total allocations: {metadata.total_allocations}")
Expand Down