Skip to content

Commit

Permalink
Schedule removal for MNE-BIDS 0.14
Browse files Browse the repository at this point in the history
  • Loading branch information
hoechenberger committed Aug 20, 2022
1 parent 6ba24b4 commit 2067021
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion doc/whats_new.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Detailed list of changes

- :func:`~mne_bids.write_raw_bids` now expects all but the first four parameters to be passed as keyword arguments, by `Richard Höchenberger`_ (:gh:`1054`)

- The ``events_data`` parameter of :func:`~mne_bids.write_raw_bids` has been deprecated in favor of a new parameter named ``events``. This ensures more consistency between the MNE-BIDS and MNE-Python APIs. You may continue using the ``events_data`` parameter for now, but a ``FutureWarning`` will be raised. ``events_data`` will be removed in a future release, by `Richard Höchenberger`_ (:gh:`1054`)
- The ``events_data`` parameter of :func:`~mne_bids.write_raw_bids` has been deprecated in favor of a new parameter named ``events``. This ensures more consistency between the MNE-BIDS and MNE-Python APIs. You may continue using the ``events_data`` parameter for now, but a ``FutureWarning`` will be raised. ``events_data`` will be removed in MNE-BIDS 0.14, by `Richard Höchenberger`_ (:gh:`1054`)

- In many places, we used to infer the ``datatype`` of a :class:`~mne_bids.BIDSPath` from the ``suffix``, if not explicitly provided. However, this has lead to trouble in certain edge cases. In an effort to reduce the amount of implicit behavior in MNE-BIDS, we now require users to explicitly specify a ``datatype`` whenever the invoked functions or methods expect one, by `Richard Höchenberger`_ (:gh:`1030`)

Expand Down
4 changes: 2 additions & 2 deletions mne_bids/write.py
Original file line number Diff line number Diff line change
Expand Up @@ -1507,8 +1507,8 @@ def write_raw_bids(
message='The events_data parameter has been deprecated in favor '
'the new events parameter, to ensure better consistency '
'with MNE-Python. The events_data parameter will be '
'removed in a future release of MNE-BIDS. Please use the '
'events parameter instead.',
'removed in MNE-BIDS 0.14. Please use the events '
'parameter instead.',
category=FutureWarning
)
events = events_data
Expand Down

0 comments on commit 2067021

Please sign in to comment.