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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MRG] update make_dataset_description #996

Merged
merged 3 commits into from Apr 6, 2022

Conversation

sappelhoff
Copy link
Member

@sappelhoff sappelhoff commented Apr 6, 2022

PR Description

馃挜 breaking change for make_dataset_description

I did the following:

  • require keyword arguments only
  • change the order of keyword arguments to be in line with the BIDS spec ordering (this is easier for users, who will often have the spec open to read the text while typing it into mne-bids)
  • add new metadata options, as they are available in BIDS
  • add some input checks so that we only allow writing valid data
  • make the docstr a bit more precise

To do

  • add some tests

Merge checklist

Maintainer, please confirm the following before merging:

  • All comments resolved
  • This is not your own PR
  • All CIs are happy
  • PR title starts with [MRG]
  • whats_new.rst is updated
  • [ ] PR description includes phrase "closes <#issue-number>"

@sappelhoff sappelhoff changed the title [ENH] update make_dataset_description [MRG] update make_dataset_description Apr 6, 2022
@sappelhoff sappelhoff added this to the 0.11 milestone Apr 6, 2022
@sappelhoff sappelhoff added the API label Apr 6, 2022
@codecov
Copy link

codecov bot commented Apr 6, 2022

Codecov Report

Merging #996 (7afbb01) into main (5e65124) will increase coverage by 0.02%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main     #996      +/-   ##
==========================================
+ Coverage   95.11%   95.14%   +0.02%     
==========================================
  Files          25       25              
  Lines        3744     3766      +22     
==========================================
+ Hits         3561     3583      +22     
  Misses        183      183              
Impacted Files Coverage 螖
mne_bids/write.py 96.82% <100.00%> (+0.07%) 猬嗭笍

Continue to review full report at Codecov.

Legend - Click here to learn more
螖 = absolute <relative> (impact), 酶 = not affected, ? = missing data
Powered by Codecov. Last update 5e65124...7afbb01. Read the comment docs.

@hoechenberger hoechenberger merged commit 5bc4216 into mne-tools:main Apr 6, 2022
@hoechenberger
Copy link
Member

Thanks @sappelhoff

@sappelhoff sappelhoff deleted the ds_descr branch April 6, 2022 19:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants