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

DOC: beef up documentation (attributes and examples section) #25

Merged
merged 1 commit into from
Feb 20, 2025

Conversation

scott-huberty
Copy link
Owner

@scott-huberty scott-huberty commented Feb 18, 2025

closes #23

  • Adds an Attributes section to the eyelinkio.edf.EDF class, and details the info and discrete attributes`, including all the keys within each of them that are populated by the reader.
  • adds multiple Examples sections to the eyelinkio.edf.EDF class, including for theto_mne and to_pandas methods. This means that with the current pytest configuration, pytest will test these docstring examples when you invoke the pytest command.

meas_date : datetime
The date and time that the data was recorded. This datetime is
timezone-naive, as the timezone is not stored in the EDF file.
version : str
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A little annoying that the EDF file does not store the time zone of the computer it records from.

In our Eyelink ASCII reader in MNE, we forcefully set the date time as UTC, even though we know that the datetime is actually in some local time-zone. I think we did that just to be compliant with MNE's info["meas_date"] standard (must be in UTC).

But here, we just keep the datetime timezone-naive, and I've left a little note about that.

@teonbrooks I'm wondering if you have an opinion on which approach you'd prefer for your data?

@scott-huberty scott-huberty merged commit 646b9fc into main Feb 20, 2025
9 checks passed
@scott-huberty scott-huberty deleted the document_attrs branch February 20, 2025 02:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Improve EDF class documentation
1 participant