Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Add a note about the units used for the time-based HRV metrics. #1049

Open
wants to merge 1 commit into
base: dev
Choose a base branch
from

Conversation

aweinstein
Copy link

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 :)

  • [X ] I have read the CONTRIBUTING file.
  • [X ] My PR is targeted at the dev branch (and not towards the master branch).
  • I ran the CODE CHECKS on the files I added or modified and fixed the errors.

Copy link

welcome bot commented Nov 15, 2024

Thanks for opening this pull request! We'll make sure it's perfect before merging 🤗 force
Make sure to read the contributing guide. Also, if you think that your contribution is worthy of it, you can consider adding yourself to the Contributors list (feel free to ask us if you have any doubts).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant