Skip to content

Commit 99a3ba8

Browse files
Merge pull request #1049 from aweinstein/fix-docstring
[Docs] Add a note about the units used for the time-based HRV metrics.
2 parents 45a5e5f + b33a7b8 commit 99a3ba8

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

neurokit2/hrv/hrv_time.py

+5
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,11 @@ def hrv_time(peaks, sampling_rate=1000, show=False, **kwargs):
9191
--------
9292
ecg_peaks, ppg_peaks, hrv_frequency, hrv_summary, hrv_nonlinear
9393
94+
Notes
95+
-----
96+
97+
Where applicable, the unit used for these metrics is the millisecond.
98+
9499
Examples
95100
--------
96101
.. ipython:: python

0 commit comments

Comments
 (0)