diff --git a/doc/run_benchmark.rst b/doc/run_benchmark.rst index 84083712..0e98e4e4 100644 --- a/doc/run_benchmark.rst +++ b/doc/run_benchmark.rst @@ -189,7 +189,7 @@ values. Specializer statistics (``pystats``) ==================================== -``pyperf`` has built-in support for `specializer statistics (``pystats``) `_. +``pyperf`` has built-in support for `specializer statistics (pystats) `_. If running benchmarks on a CPython built with the ``--enable-pystats`` flag, when you pass ``--hook pystats``, pyperf will collect ``pystats`` on the benchmark code by calling ``sys._stats_on`` immediately before the benchmark and calling ``sys._stats_off`` immediately after. Stats are not collected when running ``pyperf``'s own code or when warming up or calibrating the benchmarks.