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 single occurence from docs.py #3834

Merged
merged 2 commits into from Jul 9, 2023
Merged

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Jul 8, 2023

Closes #3832

Changes proposed in this pull request:

  • remove parameters definitions that were put in _utils.docs.py even though they are used only once in the whole code base.

@github-actions
Copy link
Contributor

github-actions bot commented Jul 8, 2023

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

@codecov
Copy link

codecov bot commented Jul 8, 2023

Codecov Report

Merging #3834 (4486bd1) into main (8c62868) will decrease coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3834      +/-   ##
==========================================
- Coverage   91.54%   91.53%   -0.01%     
==========================================
  Files         133      133              
  Lines       15629    15623       -6     
  Branches     3250     3250              
==========================================
- Hits        14307    14301       -6     
  Misses        774      774              
  Partials      548      548              
Flag Coverage Δ
macos-latest_3.10 91.46% <ø> (-0.01%) ⬇️
macos-latest_3.11 91.46% <ø> (-0.01%) ⬇️
macos-latest_3.8 91.42% <ø> (-0.01%) ⬇️
macos-latest_3.9 91.42% <ø> (-0.01%) ⬇️
ubuntu-latest_3.10 91.46% <ø> (-0.01%) ⬇️
ubuntu-latest_3.11 91.46% <ø> (-0.01%) ⬇️
ubuntu-latest_3.8 91.42% <ø> (-0.01%) ⬇️
ubuntu-latest_3.9 91.42% <ø> (-0.01%) ⬇️
windows-latest_3.10 91.40% <ø> (-0.01%) ⬇️
windows-latest_3.11 91.40% <ø> (-0.01%) ⬇️
windows-latest_3.8 91.36% <ø> (-0.01%) ⬇️
windows-latest_3.9 91.36% <ø> (-0.01%) ⬇️

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

Impacted Files Coverage Δ
nilearn/_utils/docs.py 91.80% <ø> (-0.39%) ⬇️
nilearn/plotting/html_surface.py 100.00% <ø> (ø)
nilearn/plotting/img_plotting.py 89.66% <ø> (ø)
nilearn/plotting/surf_plotting.py 95.87% <ø> (ø)
nilearn/regions/parcellations.py 98.19% <ø> (ø)
nilearn/regions/rena_clustering.py 94.93% <ø> (ø)
nilearn/signal.py 97.15% <ø> (ø)

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

@Remi-Gau Remi-Gau marked this pull request as ready for review July 8, 2023 18:45
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 too.

@Remi-Gau Remi-Gau merged commit 27fadc1 into nilearn:main Jul 9, 2023
29 checks passed
@Remi-Gau Remi-Gau deleted the defaults branch July 9, 2023 15:41
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.

update defaults in _utils/docs.py
2 participants