Skip to content
Snippets Groups Projects
Verified Commit 58f0f234 authored by David Beniamine's avatar David Beniamine
Browse files

Doc up

parent 26650f6f
No related branches found
No related tags found
No related merge requests found
Pipeline #247 failed
Stage: test
Show whitespace changes
Inline Side-by-side
Showing
with 4 additions and 2 deletions
Readme.md
+ 4
− 2
View file @ 58f0f234
...@@ -67,8 +67,8 @@ setup( ...@@ -67,8 +67,8 @@ setup(
## Usage ## Usage
```python ```python
from pyTiming.pyTiming import timer from pyTiming import pyTiming
timer = timer() # starts measuring time timer = pyTiming.timer() # starts measuring time
. . . . . .
timer.start_step('step1') timer.start_step('step1')
...@@ -89,3 +89,5 @@ timer.end() # end all measurements ...@@ -89,3 +89,5 @@ timer.end() # end all measurements
print(timer.get_analysis()) print(timer.get_analysis())
``` ```
**Warning** do not call a step `'main'` as this name is used for the global step
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment