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 section on private functions #3952

Merged
merged 2 commits into from Sep 7, 2023

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Sep 6, 2023

@github-actions
Copy link
Contributor

github-actions bot commented Sep 6, 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.

@Remi-Gau Remi-Gau marked this pull request as ready for review September 6, 2023 18:59
@codecov
Copy link

codecov bot commented Sep 6, 2023

Codecov Report

Merging #3952 (e1c6fd9) into main (d4690b9) will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #3952      +/-   ##
==========================================
+ Coverage   91.78%   91.79%   +0.01%     
==========================================
  Files         134      134              
  Lines       15772    15772              
  Branches     3284     3284              
==========================================
+ Hits        14476    14478       +2     
+ Misses        752      751       -1     
+ Partials      544      543       -1     
Flag Coverage Δ
macos-latest_3.10 91.70% <ø> (?)
macos-latest_3.11 91.70% <ø> (?)
macos-latest_3.8 91.67% <ø> (?)
macos-latest_3.9 91.67% <ø> (?)
ubuntu-latest_3.10 91.70% <ø> (?)
ubuntu-latest_3.11 91.70% <ø> (ø)
ubuntu-latest_3.8 91.67% <ø> (?)
ubuntu-latest_3.9 91.67% <ø> (?)
windows-latest_3.10 91.64% <ø> (?)
windows-latest_3.11 91.64% <ø> (?)
windows-latest_3.8 91.61% <ø> (?)
windows-latest_3.9 91.61% <ø> (?)

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

see 1 file with indirect coverage changes

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

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.

This makes it more explicit. Thx.

Copy link
Member

@ymzayek ymzayek left a comment

Choose a reason for hiding this comment

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

That's better thanks!

@ymzayek ymzayek merged commit 36648d4 into nilearn:main Sep 7, 2023
29 checks passed
@Remi-Gau Remi-Gau deleted the doc/private_func branch September 7, 2023 09:53
@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Sep 7, 2023

I just copy pasted @jeromedockes words so he should get the credit on this one

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.

improve summary in contribution documentation regarding private "functions"
3 participants