holgern / pyedflib

pyedflib is a python library to read/write EDF+/BDF+ files based on EDFlib.
http://pyedflib.readthedocs.org/
BSD 3-Clause "New" or "Revised" License
209 stars 121 forks source link

Documentation issue #238

Open mcespedes99 opened 9 months ago

mcespedes99 commented 9 months ago

Hi, I've noticed a minor but important mistake in the documentation here. I got an error using version 0.1.32 when trying to set the Datarecord Duration using units of 10 us (as specified in the documentation) and got an Overflow error saying the number was too big. This surprised me as it was code that I tested before and had no issues with it (using another venv). So I compared the versions and I had before 0.1.30. I checked the code and it seems you changed the behaviour of function (now it receives the value in seconds, when before it used to received it in values of 10 us) but not the documentation.

I'd would be great if you could make a note of this in the documentation, also including the fact that you changed it recently, so that no one else gets confused!