Skip to content

Commit eb36fbc

Browse files
Updated refleak documentation to include default
1 parent 1702799 commit eb36fbc

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

testing/run-write-tests.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,14 @@ To check for reference leaks (only needed if you modified C code),
9090
you can enable reference leak checking during testing using the ``-R`` flag.
9191
For example, using the command::
9292

93+
python -m test <test_name> -R :
94+
95+
This default setting performs a few initial warm-up runs to stabilize the reference count,
96+
followed by additional runs to check for leaks.
97+
98+
If you want more control over the number of runs, you can specify ``warmups`` and ``repeats`` explicitly
99+
For example::
100+
93101
python -m test <test_name> -R <warmups>:<repeats>
94102

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

0 commit comments

Comments
 (0)