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] Improve docstrings of maskers #3414

Merged
merged 3 commits into from Apr 25, 2023
Merged

Conversation

ymzayek
Copy link
Member

@ymzayek ymzayek commented Nov 18, 2022

Addresses part of #3384 .

Changes proposed in this pull request:

  • Add docs about attributes to multi subject maskers
  • Make docstrings consistent across maskers
  • Use standard docs where possible

@github-actions
Copy link
Contributor

👋 @ymzayek 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"
  • Code is PEP8-compliant.
  • (Bug fixes) There is at least one test that would fail under the original bug conditions.
  • (New features) There is at least one unit test per new function / class.
  • (New features) The new feature is demoed in at least one relevant example.

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

@codecov
Copy link

codecov bot commented Nov 18, 2022

Codecov Report

Merging #3414 (29dfe52) into main (cdebb69) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff            @@
##             main    #3414    +/-   ##
========================================
  Coverage   91.57%   91.57%            
========================================
  Files         139      139            
  Lines       16575    16577     +2     
  Branches     3061     3233   +172     
========================================
+ Hits        15178    15180     +2     
  Misses       1394     1394            
  Partials        3        3            
Impacted Files Coverage Δ
nilearn/maskers/multi_nifti_labels_masker.py 100.00% <ø> (ø)
nilearn/maskers/multi_nifti_maps_masker.py 100.00% <ø> (ø)
nilearn/maskers/multi_nifti_masker.py 97.72% <ø> (ø)
nilearn/maskers/nifti_labels_masker.py 93.71% <ø> (ø)
nilearn/maskers/nifti_maps_masker.py 97.68% <ø> (ø)
nilearn/maskers/nifti_masker.py 91.83% <ø> (+0.05%) ⬆️
nilearn/maskers/nifti_spheres_masker.py 96.57% <ø> (ø)
nilearn/_utils/docs.py 93.65% <100.00%> (+0.05%) ⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@Remi-Gau Remi-Gau added the Documentation for documentation related questions or requests label Feb 20, 2023
@ymzayek ymzayek marked this pull request as ready for review April 24, 2023 15:46
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.

LGTM, thx !

Copy link
Member

@NicolasGensollen NicolasGensollen left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @ymzayek !

@ymzayek ymzayek merged commit 78000d2 into nilearn:main Apr 25, 2023
29 checks passed
@ymzayek ymzayek deleted the maskers-docstrings branch April 25, 2023 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation for documentation related questions or requests
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants