[Docs] Add a note about the units used for the time-based HRV metrics. #1049
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR aims at improving the docstring of
hrv_time
function. This PR should fix #1046.Proposed Changes
I added a note to the docstring stating that "Where applicable, the unit used for these metrics is the millisecond."
Checklist
Here are some things to check before creating the PR. If you encounter any issues, do let us know :)