Merge pull request #86 from e10v/dev

Minor changes
e10v · Aug 10, 2024 · fa5b7f7 · fa5b7f7
2 parents 19ee525 + 74676b3
commit fa5b7f7
Show file tree

Hide file tree

Showing 6 changed files with 155 additions and 116 deletions.
diff --git a/docs/power-analysis.md b/docs/power-analysis.md
@@ -77,4 +77,4 @@ print(power_result)
 
 In the example above, **tea-tasting** calculates the relative and absolute effect size for all metrics for two possible sample size values, `10_000` and `20_000`.
 
-The `solve_power` methods of a [metric](api/metrics/mean.md#tea_tasting.metrics.mean.Mean.solve_power) and of an [experiment](api/experiment.md#tea_tasting.experiment.Experiment.solve_power) return the instances of [`MeanPowerResult`](api/metrics/mean.md#tea_tasting.metrics.mean.MeanPowerResult) and [`ExperimentPowerResult`](api/experiment.md#tea_tasting.experiment.ExperimentPowerResult) respectively. These result classes provide the serialization methods similar to the experiment result: `to_dicts`, `to_pandas`, `to_pretty`, `to_string`, `to_html`.
+The `solve_power` methods of a [metric](api/metrics/mean.md#tea_tasting.metrics.mean.Mean.solve_power) and of an [experiment](api/experiment.md#tea_tasting.experiment.Experiment.solve_power) return the instances of [`MetricPowerResults`](api/metrics/base.md#tea_tasting.metrics.base.MetricPowerResults) and [`ExperimentPowerResult`](api/experiment.md#tea_tasting.experiment.ExperimentPowerResult) respectively. These result classes provide the serialization methods similar to the experiment result: `to_dicts`, `to_pandas`, `to_pretty`, `to_string`, `to_html`.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,6 +1,6 @@
 site_name: "tea-tasting: statistical analysis of A/B tests"
 site_url: https://tea-tasting.e10v.me/
-site_description: A Python package for statistical analysis of A/B tests
+site_description: A Python package for the statistical analysis of A/B tests
 site_author: Evgeny Ivanov
 copyright: © Evgeny Ivanov
 repo_name: e10v/tea-tasting
Original file line number	Diff line number	Diff line change
Expand Up		@@ -77,4 +77,4 @@ print(power_result)

		In the example above, tea-tasting calculates the relative and absolute effect size for all metrics for two possible sample size values, `10_000` and `20_000`.

		The `solve_power` methods of a [metric](api/metrics/mean.md#tea_tasting.metrics.mean.Mean.solve_power) and of an [experiment](api/experiment.md#tea_tasting.experiment.Experiment.solve_power) return the instances of [`MeanPowerResult`](api/metrics/mean.md#tea_tasting.metrics.mean.MeanPowerResult) and [`ExperimentPowerResult`](api/experiment.md#tea_tasting.experiment.ExperimentPowerResult) respectively. These result classes provide the serialization methods similar to the experiment result: `to_dicts`, `to_pandas`, `to_pretty`, `to_string`, `to_html`.
		The `solve_power` methods of a [metric](api/metrics/mean.md#tea_tasting.metrics.mean.Mean.solve_power) and of an [experiment](api/experiment.md#tea_tasting.experiment.Experiment.solve_power) return the instances of [`MetricPowerResults`](api/metrics/base.md#tea_tasting.metrics.base.MetricPowerResults) and [`ExperimentPowerResult`](api/experiment.md#tea_tasting.experiment.ExperimentPowerResult) respectively. These result classes provide the serialization methods similar to the experiment result: `to_dicts`, `to_pandas`, `to_pretty`, `to_string`, `to_html`.