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] update doc strings of the maskers #4286

Merged
merged 2 commits into from Feb 27, 2024
Merged

Conversation

Remi-Gau
Copy link
Collaborator

Changes proposed in this pull request:

  • clarify the maskers Classes doc strings to help differentiate them
  • link to the user guide section on labels and maps

Comment on lines +21 to +22
For more details on the definitions of labels in Nilearn,
see the :ref:`region` section.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I would be tempted (in another PR) to add label (brain region) and maps (brain region) (as defined in the user guide) as part of the nilearn glossary to make it easier to link to them.

Though obviously this would have to be disinguished from "statistcal maps", "class labels"...

@Remi-Gau Remi-Gau marked this pull request as ready for review February 26, 2024 09:49
Copy link
Contributor

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

  • 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 Feb 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.98%. Comparing base (abb80ff) to head (50a1703).
Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4286      +/-   ##
==========================================
+ Coverage   91.85%   91.98%   +0.12%     
==========================================
  Files         144      144              
  Lines       16419    16422       +3     
  Branches     3434     3436       +2     
==========================================
+ Hits        15082    15106      +24     
+ Misses        792      772      -20     
+ Partials      545      544       -1     
Flag Coverage Δ
macos-latest_3.10_test_plotting 91.85% <ø> (?)
macos-latest_3.11_test_plotting 91.85% <ø> (+<0.01%) ⬆️
macos-latest_3.12_test_plotting 91.85% <ø> (?)
macos-latest_3.8_test_plotting 91.81% <ø> (?)
macos-latest_3.9_test_plotting 91.82% <ø> (?)
ubuntu-latest_3.10_test_plotting 91.85% <ø> (+<0.01%) ⬆️
ubuntu-latest_3.11_test_plotting 91.85% <ø> (?)
ubuntu-latest_3.12_test_pre 91.85% <ø> (?)
ubuntu-latest_3.8_test_min 68.93% <ø> (?)
ubuntu-latest_3.8_test_plotting 91.81% <ø> (?)
windows-latest_3.10_test_plotting 91.83% <ø> (?)
windows-latest_3.11_test_plotting 91.83% <ø> (?)
windows-latest_3.12_test_plotting 91.83% <ø> (?)
windows-latest_3.8_test_plotting 91.79% <ø> (?)
windows-latest_3.9_test_plotting 91.80% <ø> (?)

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.

@Remi-Gau
Copy link
Collaborator Author

The API page looks a bit more helpful that way.

image

@Remi-Gau Remi-Gau merged commit 81fd81b into nilearn:main Feb 27, 2024
32 checks passed
@Remi-Gau Remi-Gau deleted the fix/4276 branch February 27, 2024 08:18
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.

Maskers classes description in API section do not help users know what each is for
2 participants