Skip to content

Commit

Permalink
Fix some typos in the docs (#120)
Browse files Browse the repository at this point in the history
There are some small typos in the different configuration options in the docs.
  • Loading branch information
vlad-ro authored Jul 18, 2024
1 parent 9810859 commit 6e1647d
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Configuration
=============

This plugin provides a clean minimal set of command line options that are added to pytest.
You can also specify most options in `pytest.ini` file.
The complete list of command line options is:

.. tab:: Command line options
Expand Down Expand Up @@ -38,8 +39,8 @@ The complete list of command line options is:
``memray(bool)``
Activate memray tracking.

``most-allocations(string)``
Show the N tests that allocate most memory (N=0 for all).
``most_allocations(int)``
Show the N tests that allocate most memory (N=0 for all, default=5).

``hide_memray_summary(bool)``
Hide the memray summary at the end of the execution.
Expand All @@ -53,5 +54,5 @@ The complete list of command line options is:
``trace_python_allocators(bool)``
Record allocations made by the Pymalloc allocator (will be slower)

``--fail-on-increase(bool)``
Fail a test with the limit_memory marker if it uses more memory than its last successful run
``fail-on-increase(bool)``
Fail a test with the limit_memory marker if it uses more memory than its last successful run

0 comments on commit 6e1647d

Please sign in to comment.