From 6e1647d4a816c84aa38dc3361eae2f6a87c3b275 Mon Sep 17 00:00:00 2001 From: Vlad Romanenko Date: Thu, 18 Jul 2024 04:16:38 -0700 Subject: [PATCH] Fix some typos in the docs (#120) There are some small typos in the different configuration options in the docs. --- docs/configuration.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/configuration.rst b/docs/configuration.rst index a7049bc..567a451 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -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 @@ -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. @@ -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 \ No newline at end of file + ``fail-on-increase(bool)`` + Fail a test with the limit_memory marker if it uses more memory than its last successful run