updated docstrings for n_min_threshold

JuliaKukulies commented 5 months ago

Solves #427

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

github-actions[bot] commented 5 months ago

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.}

codecov[bot] commented 5 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

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

```diff @@ 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](https://app.codecov.io/gh/tobac-project/tobac/pull/432/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tobac-project) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/tobac-project/tobac/pull/432/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tobac-project) | `60.91% <ø> (+0.19%)` | :arrow_up: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=tobac-project#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

fsenf commented 3 months ago

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

JuliaKukulies commented 3 months ago

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

That'd be awesome :)

fziegner commented 3 months ago

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 commented 3 months ago

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

tobac-project / tobac

updated docstrings for n_min_threshold #432

Linting results by Pylint:

Codecov Report