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] remove warning from experimental module and add it as doc string #4240

Merged
merged 1 commit into from Jan 26, 2024

Conversation

Remi-Gau
Copy link
Collaborator

Changes proposed in this pull request:

  • remove warning from experimental module
  • add it as part of the doc string to be rendered in the doc

@Remi-Gau Remi-Gau added this to the release 0.10.3 milestone Jan 26, 2024
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 Jan 26, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (d0cbdcd) 92.06% compared to head (495f19b) 92.06%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4240      +/-   ##
==========================================
- Coverage   92.06%   92.06%   -0.01%     
==========================================
  Files         144      144              
  Lines       16421    16419       -2     
  Branches     3434     3434              
==========================================
- Hits        15118    15116       -2     
  Misses        761      761              
  Partials      542      542              
Flag Coverage Δ
macos-latest_3.10_test_plotting ?
macos-latest_3.11_test_plotting 91.85% <ø> (-0.01%) ⬇️
macos-latest_3.12_test_plotting ?
macos-latest_3.8_test_plotting 91.81% <ø> (-0.01%) ⬇️
macos-latest_3.9_test_plotting ?
ubuntu-latest_3.10_test_plotting 91.85% <ø> (-0.01%) ⬇️
ubuntu-latest_3.11_test_plotting 91.85% <ø> (-0.01%) ⬇️
ubuntu-latest_3.12_test_plotting 91.85% <ø> (-0.01%) ⬇️
ubuntu-latest_3.12_test_pre ?
ubuntu-latest_3.8_test_min 68.94% <ø> (-0.01%) ⬇️
ubuntu-latest_3.8_test_plot_min 91.56% <ø> (-0.01%) ⬇️
ubuntu-latest_3.8_test_plotting 91.81% <ø> (-0.01%) ⬇️
ubuntu-latest_3.9_test_plotting 91.82% <ø> (-0.01%) ⬇️
windows-latest_3.10_test_plotting 91.83% <ø> (-0.01%) ⬇️
windows-latest_3.11_test_plotting 91.83% <ø> (-0.01%) ⬇️
windows-latest_3.12_test_plotting 91.83% <ø> (-0.01%) ⬇️
windows-latest_3.8_test_plotting 91.79% <ø> (-0.01%) ⬇️
windows-latest_3.9_test_plotting 91.79% <ø> (-0.01%) ⬇️

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.

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.

Good with me.

@jeromedockes
Copy link
Member

LGTM, thanks!

screenshot_2024-01-26T10:49:28+01:00

@Remi-Gau Remi-Gau merged commit 48cc9ab into nilearn:main Jan 26, 2024
30 of 32 checks passed
@Remi-Gau Remi-Gau deleted the rm_warning branch January 26, 2024 09:54
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.

None yet

3 participants