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] Add versionadded directive to two_sided parameter of binarize_img function #4262

Merged

Conversation

NicolasGensollen
Copy link
Member

Hi,

It looks like a two_sided parameter was recently added to binarize_img (see #4121). However, the documentation doesn't specify the version in which it was added (0.10.3).
Not sure if people use these, but I actually was looking for this information on the API page of the function, and ended up looking at the changelog to know.

Copy link
Contributor

github-actions bot commented Feb 5, 2024

👋 @NicolasGensollen 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
Copy link
Collaborator

Remi-Gau commented Feb 5, 2024

good catch

thanks @NicolasGensollen

Copy link

codecov bot commented Feb 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (abb80ff) 91.85% compared to head (0f68c14) 68.94%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@             Coverage Diff             @@
##             main    #4262       +/-   ##
===========================================
- Coverage   91.85%   68.94%   -22.92%     
===========================================
  Files         144      144               
  Lines       16419    16413        -6     
  Branches     3434     3129      -305     
===========================================
- Hits        15082    11316     -3766     
- Misses        792     4670     +3878     
+ Partials      545      427      -118     
Flag Coverage Δ
macos-latest_3.11_test_plotting ?
ubuntu-latest_3.10_test_plotting ?
ubuntu-latest_3.8_test_min 68.94% <ø> (?)

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.

@Remi-Gau Remi-Gau merged commit 5e09d0b into nilearn:main Feb 5, 2024
31 of 32 checks passed
@NicolasGensollen NicolasGensollen deleted the doc-add-version-added-binarize-img branch February 5, 2024 22:09
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

2 participants