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] Refer to nilearn datasets module #4320

Merged
merged 4 commits into from Mar 18, 2024
Merged

Conversation

man-shu
Copy link
Contributor

@man-shu man-shu commented Mar 18, 2024

Changes proposed in this pull request:

Copy link
Contributor

👋 @man-shu 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.

  • PR has an interpretable title.
  • PR links to Github issue with mention Closes #XXXX (see our documentation on PR structure)
  • Code is PEP8-compliant (see our documentation on coding style)
  • Changelog or what's new entry in doc/changes/latest.rst (see our documentation on PR structure)

For new features:

  • There is at least one unit test per new function / class (see our documentation on testing)
  • The new feature is demoed in at least one relevant example.

For bug fixes:

  • There is at least one test that would fail under the original bug conditions.

We will review it as quick as possible, feel free to ping us with questions if needed.

Copy link

codecov bot commented Mar 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.13%. Comparing base (abb80ff) to head (cb03245).
Report is 28 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4320      +/-   ##
==========================================
+ Coverage   91.85%   92.13%   +0.27%     
==========================================
  Files         144      143       -1     
  Lines       16419    16452      +33     
  Branches     3434     3451      +17     
==========================================
+ Hits        15082    15158      +76     
+ Misses        792      749      -43     
  Partials      545      545              
Flag Coverage Δ
macos-latest_3.10_test_plotting 91.92% <ø> (?)
macos-latest_3.11_test_plotting 91.92% <ø> (+0.07%) ⬆️
macos-latest_3.12_test_plotting 91.92% <ø> (?)
macos-latest_3.9_test_plotting 91.89% <ø> (?)
ubuntu-latest_3.10_test_plotting 91.92% <ø> (+0.07%) ⬆️
ubuntu-latest_3.11_test_plotting 91.92% <ø> (?)
ubuntu-latest_3.12_test_plotting 91.92% <ø> (?)
ubuntu-latest_3.8_test_min 68.81% <ø> (?)
ubuntu-latest_3.8_test_plot_min 91.59% <ø> (?)
ubuntu-latest_3.8_test_plotting 91.88% <ø> (?)
ubuntu-latest_3.9_test_plotting 91.89% <ø> (?)
windows-latest_3.10_test_plotting 91.90% <ø> (?)
windows-latest_3.11_test_plotting 91.90% <ø> (?)
windows-latest_3.12_test_plotting 91.90% <ø> (?)
windows-latest_3.8_test_plotting 91.86% <ø> (?)
windows-latest_3.9_test_plotting 91.87% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

CONTRIBUTING.rst Outdated Show resolved Hide resolved
CONTRIBUTING.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@Remi-Gau Remi-Gau left a comment

Choose a reason for hiding this comment

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

use internal sphinx reference rather than external links

Copy link
Member

@bthirion bthirion left a comment

Choose a reason for hiding this comment

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

Thx !

@bthirion bthirion merged commit 76a4092 into nilearn:main Mar 18, 2024
32 of 33 checks passed
@man-shu man-shu deleted the ref_nilearn_data branch March 20, 2024 20:06
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] Unclear what are nilearn datasets on the contributing page
3 participants