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
[ENH] add readme to default data locations #4037
Conversation
👋 @Remi-Gau Thanks for creating a PR! Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft. Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.
For new features:
For bug fixes:
We will review it as quick as possible, feel free to ping us with questions if needed. |
Codecov Report
@@ Coverage Diff @@
## main #4037 +/- ##
==========================================
- Coverage 91.75% 91.57% -0.18%
==========================================
Files 145 143 -2
Lines 16222 16066 -156
Branches 3370 3336 -34
==========================================
- Hits 14884 14712 -172
- Misses 795 811 +16
Partials 543 543
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 10 files with indirect coverage changes 📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM otherwise.
Co-authored-by: bthirion <bertrand.thirion@inria.fr>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Maybe not necessary but it would be good to just test that the file is created in the right location.
from nilearn import datasets | ||
from nilearn.datasets import utils | ||
from nilearn.datasets.utils import _get_dataset_descr |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
unrelated but simplified the imports a bit
def test_add_readme_to_default_data_locations(tmp_path): | ||
assert not (tmp_path / "README.md").exists() | ||
utils._get_dataset_dir(dataset_name="test", verbose=0, data_dir=tmp_path) | ||
assert (tmp_path / "README.md").exists() |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
simple test added
Changes proposed in this pull request: