diff --git a/src/tea_tasting/metrics/mean.py b/src/tea_tasting/metrics/mean.py index 86b9b36..3b39048 100644 --- a/src/tea_tasting/metrics/mean.py +++ b/src/tea_tasting/metrics/mean.py @@ -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/) @@ -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/) diff --git a/src/tea_tasting/metrics/resampling.py b/src/tea_tasting/metrics/resampling.py index b65ad5e..5e93641 100644 --- a/src/tea_tasting/metrics/resampling.py +++ b/src/tea_tasting/metrics/resampling.py @@ -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/) @@ -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 diff --git a/src/tea_tasting/utils.py b/src/tea_tasting/utils.py index 7528dbb..2dc2c24 100644 --- a/src/tea_tasting/utils.py +++ b/src/tea_tasting/utils.py @@ -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.