Bullet-ize test_stat docstring

scikit-hep · Feb 11, 2021 · 0c1a0e1 · 0c1a0e1
1 parent 887c1c2
commit 0c1a0e1
Showing 1 changed file with 8 additions and 6 deletions.
diff --git a/src/pyhf/infer/calculators.py b/src/pyhf/infer/calculators.py
@@ -198,12 +198,14 @@ def __init__(
               during minimization.
             test_stat (:obj:`str`): The test statistic to use as a numerical summary of the
               data: ``'qtilde'``, ``'q'``, or ``'q0'``.
-              ``'qtilde'`` (default) performs the calculation using the alternative test statistic,
-              :math:`\tilde{q}_{\mu}`, as defined under the Wald approximation in Equation (62)
-              of :xref:`arXiv:1007.1727` (:func:`~pyhf.infer.test_statistics.qmu_tilde`), ``'q'``
-              performs the calculation using the test statistic :math:`q_{\mu}`
-              (:func:`~pyhf.infer.test_statistics.qmu`), and ``'q0'`` perfoms the calculation using
-              the discovery test statistic :math:`q_{0}` (:func:`~pyhf.infer.test_statistics.q0`).
+
+              * ``'qtilde'`` (default) performs the calculation using the alternative test statistic,
+                :math:`\tilde{q}_{\mu}`, as defined under the Wald approximation in Equation (62)
+                of :xref:`arXiv:1007.1727` (:func:`~pyhf.infer.test_statistics.qmu_tilde`).
+              * ``'q'`` performs the calculation using the test statistic :math:`q_{\mu}`
+                (:func:`~pyhf.infer.test_statistics.qmu`).
+              * ``'q0'`` performs the calculation using the discovery test statistic
+                :math:`q_{0}` (:func:`~pyhf.infer.test_statistics.q0`).
             calc_base_dist (:obj:`str`): The statistical distribution, ``'normal'`` or
               ``'clipped_normal'``, to use for calculating the :math:`p`-values.