Skip to content

Commit

Permalink
Add some documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jipolanco committed Mar 22, 2021
1 parent b813e2f commit 5a8dfa4
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -356,6 +356,10 @@ By default, debug timings are disabled, and this conditional should be optimized
If a user calls `TimerOutputs.enable_debug_timings(<module>)`, the `<module>.timeit_debug_enabled()` method will be redefined, causing all dependent methods to be recompiled within that module.
This may take a while, and hence is intended only for debugging usage, however all calls to `@timeit_debug` (within that Module) will thereafter be enabled.

As an alternative to `@timeit_debug`, this package also provides a `NoTimerOutput` type that allows disabling all timings with zero overhead.
This type represents a dummy timer which acts as a drop-in replacement for regular `TimerOutput`s.
From a user's perspective, it suffices to replace `to = TimerOutput()` by `to = NoTimerOutput()` at the beginning of their code to fully disable timers.

## Author

Kristoffer Carlsson - @KristofferC
Expand Down

0 comments on commit 5a8dfa4

Please sign in to comment.