Skip to content

Commit

Permalink
Improve docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
e10v committed Jul 14, 2024
1 parent b87cdf7 commit 5abf932
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions src/tea_tasting/metrics/mean.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ def __init__( # noqa: PLR0913
in the control variant.
Parameter defaults:
Defaults for the parameters `alpha`, `alternative`, `confidence_level`,
Defaults for parameters `alpha`, `alternative`, `confidence_level`,
`equal_var`, `n_obs`, `power`, `ratio`, and `use_t` can be changed
using the `config_context` and `set_context` functions.
See the [Global configuration](https://tea-tasting.e10v.me/api/config/)
Expand Down Expand Up @@ -731,7 +731,7 @@ def __init__( # noqa: PLR0913
in the control variant.
Parameter defaults:
Defaults for the parameters `alpha`, `alternative`, `confidence_level`,
Defaults for parameters `alpha`, `alternative`, `confidence_level`,
`equal_var`, `n_obs`, `power`, `ratio`, and `use_t` can be changed
using the `config_context` and `set_context` functions.
See the [Global configuration](https://tea-tasting.e10v.me/api/config/)
Expand Down
6 changes: 3 additions & 3 deletions src/tea_tasting/metrics/resampling.py
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ def __init__( # noqa: PLR0913
in the control variant.
Parameter defaults:
Defaults for the parameters `alternative`, `confidence_level`,
Defaults for parameters `alternative`, `confidence_level`,
and `n_resamples` can be changed using the
`config_context` and `set_context` functions.
See the [Global configuration](https://tea-tasting.e10v.me/api/config/)
Expand Down Expand Up @@ -293,14 +293,14 @@ def __init__( # noqa: PLR0913
in the control variant.
Parameter defaults:
Defaults for the parameters `alternative`, `confidence_level`,
Defaults for parameters `alternative`, `confidence_level`,
and `n_resamples` can be changed using the
`config_context` and `set_context` functions.
See the [Global configuration](https://tea-tasting.e10v.me/api/config/)
reference for details.
Default method:
The default method is "basic" which is different from the default
Default method is "basic" which is different from default
method "bca" in `Bootstrap`. The "bca" confidence intervals cannot
be calculated when the bootstrap distribution is degenerate
(e.g. all elements are identical). This is often the case for the
Expand Down
12 changes: 6 additions & 6 deletions src/tea_tasting/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ def check_scalar( # noqa: PLR0913
value: Parameter value.
name: Parameter name.
typ: Acceptable data types.
ge: If not `None`, check that the parameter value is greater than
ge: If not `None`, check that parameter value is greater than
or equal to `ge`.
gt: If not `None`, check that the parameter value is greater than `gt`.
le: If not `None`, check that the parameter value is less than or equal to `le`.
lt: If not `None`, check that the parameter value is less than `lt`.
ne: If not `None`, check that the parameter value is not equal to `ne`.
in_: If not `None`, check that the parameter value is in `in_`.
gt: If not `None`, check that parameter value is greater than `gt`.
le: If not `None`, check that parameter value is less than or equal to `le`.
lt: If not `None`, check that parameter value is less than `lt`.
ne: If not `None`, check that parameter value is not equal to `ne`.
in_: If not `None`, check that parameter value is in `in_`.
Returns:
Parameter value.
Expand Down

0 comments on commit 5abf932

Please sign in to comment.