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.

Sign up for GitHub

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

Jump to bottom

Wrong and misleading docstring for setDatarecordDuration #8

Closed
fresann opened this issue Nov 12, 2016 · 1 comment
Closed

Wrong and misleading docstring for setDatarecordDuration #8

fresann opened this issue Nov 12, 2016 · 1 comment

Comments

@fresann
Copy link

fresann commented Nov 12, 2016 •
edited

Hey,

Just wanted to point out that the documentation for EdfWriter.setDatarecordDuration is wrong and a bit misleading.

Looking at the corresponding function edf_set_datarecord_duration in edflib.c it is clear that the duration should be in the range 0.001 to 60 seconds, not 0.05 to 20.0 seconds. This is also documented in edflib.h.

Also, it could be good to point out that the unit of the duration is in 10 microseconds. Now you get the picture that the unit is 1 seconds. This caused me some grey hairs as I tried to set a non-integer sample rate 😄

Appreciate your work on the library!
holgern added a commit that referenced this issue Nov 13, 2016
@holgern
fix issue #8
1659179
@holgern
Copy link
Owner

holgern commented Nov 13, 2016

Thank you for reporting this!

@holgern holgern closed this as completed Nov 13, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@holgern @fresann