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

[MAINT] change function privacy in _utils #4061

Merged
merged 9 commits into from Oct 17, 2023
Merged

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Oct 16, 2023

Changes proposed in this pull request:

  • ensure that private functions to the module have leading underscore
  • ensure that public functions to the module have no leading underscore

@github-actions
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.

@Remi-Gau Remi-Gau changed the title [MAINT] change function privacy in data_gen [MAINT] change function privacy in _utils Oct 16, 2023
@codecov
Copy link

codecov bot commented Oct 16, 2023

Codecov Report

Merging #4061 (493ca0e) into main (96755a4) will not change coverage.
The diff coverage is 97.47%.

@@           Coverage Diff           @@
##             main    #4061   +/-   ##
=======================================
  Coverage   91.60%   91.60%           
=======================================
  Files         143      143           
  Lines       16072    16072           
  Branches     3339     3339           
=======================================
  Hits        14722    14722           
  Misses        804      804           
  Partials      546      546           
Flag Coverage Δ
macos-latest_3.10 ?
macos-latest_3.11 ?
macos-latest_3.12 91.49% <96.63%> (ø)
macos-latest_3.8 91.45% <96.63%> (ø)
macos-latest_3.9 ?
ubuntu-latest_3.10 91.49% <96.63%> (ø)
ubuntu-latest_3.11 91.49% <96.63%> (ø)
ubuntu-latest_3.12 ?
ubuntu-latest_3.8 91.45% <96.63%> (ø)
ubuntu-latest_3.9 ?
windows-latest_3.10 91.43% <96.63%> (ø)
windows-latest_3.11 91.43% <96.63%> (ø)
windows-latest_3.12 91.43% <96.63%> (ø)
windows-latest_3.8 91.39% <96.63%> (ø)
windows-latest_3.9 91.40% <96.63%> (ø)

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

Files Coverage Δ
nilearn/_utils/__init__.py 100.00% <100.00%> (ø)
nilearn/_utils/data_gen.py 95.52% <100.00%> (ø)
nilearn/_utils/fmriprep_confounds.py 100.00% <100.00%> (ø)
nilearn/_utils/helpers.py 82.75% <100.00%> (ø)
nilearn/_utils/logger.py 100.00% <100.00%> (ø)
nilearn/_utils/ndimage.py 88.88% <100.00%> (ø)
nilearn/_utils/niimg.py 97.11% <100.00%> (ø)
nilearn/_utils/niimg_conversions.py 90.47% <100.00%> (ø)
nilearn/_utils/param_validation.py 100.00% <100.00%> (ø)
nilearn/_utils/path_finding.py 100.00% <100.00%> (ø)
... and 27 more

📣 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 October 16, 2023 16:56
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 overall.

nilearn/_utils/tests/test_niimg_conversions.py Outdated Show resolved Hide resolved
@Remi-Gau Remi-Gau merged commit befe286 into nilearn:main Oct 17, 2023
31 checks passed
@Remi-Gau Remi-Gau deleted the data_gen branch October 17, 2023 11:12
@Remi-Gau
Copy link
Collaborator Author

apparently we get some errors in doc build following 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.

make sure public / private functions in _utils to start without / with a leading underscore
2 participants