neuropsychology / NeuroKit

NeuroKit2: The Python Toolbox for Neurophysiological Signal Processing
https://neuropsychology.github.io/NeuroKit
MIT License
1.58k stars 420 forks source link

[Docs] improve documentation of ECG peak-finding methods #719

Closed danibene closed 1 year ago

danibene commented 2 years ago

Describe the solution you'd like Currently, the documentation of some of the algorithms for finding peaks in ECG signals is missing details: https://github.com/neuropsychology/NeuroKit/blob/9fa23adc617bdff846bd527eb23618627682aaf8/neurokit2/ecg/ecg_peaks.py#L21-L43

How could we do it? Add a short description of how the methods are implemented to the ecg_peaks() docstring.

stale[bot] commented 1 year ago

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.