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

updated docstrings for n_min_threshold #432

Merged

Conversation

JuliaKukulies
Copy link
Member

Solves #427

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you added NumPy docstrings for newly added functions?
  • Have you formatted your code using black?
  • If you have introduced a new functionality, have you added adequate unit tests?
  • Have all tests passed in your local clone?
  • If you have introduced a new functionality, have you added an example notebook?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

Copy link

github-actions bot commented Jun 21, 2024

Linting results by Pylint:

Your code has been rated at 8.70/10 (previous run: 8.70/10, +0.00)
The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the RC_v1.5.x branch.
A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.

Copy link

codecov bot commented Jun 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.91%. Comparing base (8e7557c) to head (5551fb7).
Report is 153 commits behind head on RC_v1.5.x.

Additional details and impacted files
@@              Coverage Diff              @@
##           RC_v1.5.x     #432      +/-   ##
=============================================
+ Coverage      60.71%   60.91%   +0.19%     
=============================================
  Files             23       23              
  Lines           3541     3541              
=============================================
+ Hits            2150     2157       +7     
+ Misses          1391     1384       -7     
Flag Coverage Δ
unittests 60.91% <ø> (+0.19%) ⬆️

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.

Copy link
Member

@freemansw1 freemansw1 left a comment

Choose a reason for hiding this comment

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

Thanks, @JuliaKukulies .

@freemansw1 freemansw1 added this to the Version 1.5.4 milestone Jul 19, 2024
@freemansw1 freemansw1 requested review from kelcyno and removed request for w-k-jones and harrietgilmour July 19, 2024 14:18
@fsenf fsenf requested a review from fziegner July 31, 2024 12:53
@fsenf
Copy link
Member

fsenf commented Jul 31, 2024

@fziegner can jump in here and do the 2nd review if it is fine for @kelcyno

@JuliaKukulies
Copy link
Member Author

@fziegner can jump in here and do the 2nd review if it is fine for @kelcyno

That'd be awesome :)

Copy link
Collaborator

@fziegner fziegner left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@fziegner
Copy link
Collaborator

fziegner commented Aug 2, 2024

Something I overlooked: it might be good to change the type hint to Union[int, dict[float, int], list[int]] = 0 and docstring to n_min_threshold : int, dict of float to int, or list of int, optional as it's done the same for other variables.

@JuliaKukulies
Copy link
Member Author

Thanks @fziegner! I have addressed your comments now and will merge once the tests have passed :)

@JuliaKukulies JuliaKukulies merged commit 7d7503e into tobac-project:RC_v1.5.x Aug 14, 2024
21 checks passed
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.

4 participants