8000 [DOC] use template doc string for dummy y by Remi-Gau · Pull Request #5383 · nilearn/nilearn · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

[DOC] use template doc string for dummy y #5383

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

Merged
merged 2 commits into from
May 15, 2025
Merged

Conversation

Remi-Gau
Copy link
Collaborator
  • Closes none

Changes proposed in this pull request:

  • use a template doc strings for estimator methods that do not use their y parameter

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 May 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.83%. Comparing base (40af344) to head (0399255).
Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5383   +/-   ##
=======================================
  Coverage   96.83%   96.83%           
=======================================
  Files         282      282           
  Lines       38774    38794   +20     
  Branches     3839     3839           
=======================================
+ Hits        37547    37567   +20     
  Misses        677      677           
  Partials      550      550           
Flag Coverage Δ
macos-latest_3.10_plotting 95.53% <100.00%> (+<0.01%) ⬆️
macos-latest_3.11_plotting 95.53% <100.00%> (+<0.01%) ⬆️
macos-latest_3.12_plotting 95.53% <100.00%> (+<0.01%) ⬆️
macos-latest_3.13_plotting 95.53% <100.00%> (+<0.01%) ⬆️
macos-latest_3.9_min 77.72% <100.00%> (+0.01%) ⬆️
macos-latest_3.9_plot_min 95.12% <100.00%> (+<0.01%) ⬆️
macos-latest_3.9_plotting 95.53% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.10_plotting 95.55% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.11_plotting 95.55% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.12_plotting 95.55% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.13_plotting 95.55% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.13_pre 95.55% <100.00%> (+<0.01%) ⬆️
ubuntu-latest_3.9_plotting 95.55% <100.00%> (+<0.01%) ⬆️
windows-latest_3.10_plotting 95.14% <100.00%> (+8.81%) ⬆️
windows-latest_3.11_plotting 89.63% <100.00%> (-5.83%) ⬇️
windows-latest_3.12_plotting 95.53% <100.00%> (+<0.01%) ⬆️
windows-latest_3.13_plotting 95.53% <100.00%> (+<0.01%) ⬆️
windows-latest_3.9_plotting 95.53% <100.00%> (+0.07%) ⬆️

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.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@Remi-Gau Remi-Gau marked this pull request as ready for review May 15, 2025 14:38
@Remi-Gau Remi-Gau requested review from hndgzkn and man-shu and removed request for hndgzkn May 15, 2025 14:38
@Remi-Gau Remi-Gau merged commit 55beacb into nilearn:main May 15, 2025
35 checks passed
@Remi-Gau Remi-Gau deleted the doc/dummy_y branch May 15, 2025 16:50
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.

2 participants
0