From 5248abf859ba01123b11cb637c8d39d2b00ee01c Mon Sep 17 00:00:00 2001 From: RunasSudo Date: Thu, 20 Oct 2022 20:57:24 +1100 Subject: [PATCH] Clarify documentation for Mann-Whitney test --- yli/sig_tests.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/yli/sig_tests.py b/yli/sig_tests.py index 203ca27..1535b36 100644 --- a/yli/sig_tests.py +++ b/yli/sig_tests.py @@ -306,6 +306,10 @@ def mannwhitney(df, dep, ind, *, nan_policy='warn', brunnermunzel=True, use_cont :param alternative: See *scipy.stats.mannwhitneyu* :param method: See *scipy.stats.mannwhitneyu* + :return: The result of the Mann–Whitney test. + The result of a Brunner–Munzel test is included in the result object if and only if *brunnermunzel* is *True*, + *and* the Mann–Whitney test is significant, *and* the Brunner–Munzel test is non-significant. + :rtype: :class:`yli.sig_tests.MannWhitneyResult` **Example:**