Skip to content

Commit

Permalink
Add docustring
Browse files Browse the repository at this point in the history
  • Loading branch information
withmywoessner committed Jan 2, 2025
1 parent e105b37 commit cae70d7
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions mne/annotations.py
Original file line number Diff line number Diff line change
Expand Up @@ -1153,8 +1153,9 @@ def read_annotations(
r"""Read annotations from a file.
This function reads a ``.fif``, ``.fif.gz``, ``.vmrk``, ``.amrk``,
``.edf``, ``.bdf``, ``.gdf``, ``.txt``, ``.csv``, ``.cnt``, ``.cef``, or
``.set`` file and makes an :class:`mne.Annotations` object.
``.edf``, ``.bdf``, ``.gdf``, ``.txt``, ``.csv``, ``.cnt``, ``.cef``,
``.set``, or ``.seizures`` file and makes an :class:`mne.Annotations`
object.
Parameters
----------
Expand Down Expand Up @@ -1182,6 +1183,14 @@ def read_annotations(
ignore_marker_types : bool
If ``True``, ignore marker types in BrainVision files (and only use their
descriptions). Defaults to ``False``.
fmt : str | None
Used to manually specify the format of the annotations file. If
``None`` (default), the format is inferred from the file extension.
Currently only supports ``'wfdb'``.
suffix : str | None
Used to manually specify the suffix of the annotations file for WFDB
files.
If ``None`` (default), the suffix is inferred from the file extension.
Returns
-------
Expand Down

0 comments on commit cae70d7

Please sign in to comment.