Skip to content

Commit

Permalink
Updated refleak documentation to include default
Browse files Browse the repository at this point in the history
  • Loading branch information
Lincoln-developer committed Nov 6, 2024
1 parent 1702799 commit eb36fbc
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions testing/run-write-tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,14 @@ To check for reference leaks (only needed if you modified C code),
you can enable reference leak checking during testing using the ``-R`` flag.
For example, using the command::

python -m test <test_name> -R :

This default setting performs a few initial warm-up runs to stabilize the reference count,
followed by additional runs to check for leaks.

If you want more control over the number of runs, you can specify ``warmups`` and ``repeats`` explicitly
For example::

python -m test <test_name> -R <warmups>:<repeats>

This enables the refleak checker option, allowing you to perform warm-up runs
Expand Down

0 comments on commit eb36fbc

Please sign in to comment.