Merge pull request #1049 from aweinstein/fix-docstring

[Docs] Add a note about the units used for the time-based HRV metrics.
neuropsychology · Nov 25, 2024 · 99a3ba8 · 99a3ba8
2 parents 45a5e5f + b33a7b8
commit 99a3ba8
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/neurokit2/hrv/hrv_time.py b/neurokit2/hrv/hrv_time.py
@@ -91,6 +91,11 @@ def hrv_time(peaks, sampling_rate=1000, show=False, **kwargs):
     --------
     ecg_peaks, ppg_peaks, hrv_frequency, hrv_summary, hrv_nonlinear
 
+    Notes
+    -----
+
+    Where applicable, the unit used for these metrics is the millisecond.
+
     Examples
     --------
     .. ipython:: python