Skip to content

Commit

Permalink
docs: Add commas to infer.mle.fixed_poi_fit docstring for clarity (#1273
Browse files Browse the repository at this point in the history
)

* Add commas around constrained maximal likelihood for reading clarity
* Add Pradyumna to list of contributors
  • Loading branch information
1nF0rmed authored Jan 21, 2021
1 parent fed49ca commit 4b85957
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
1 change: 1 addition & 0 deletions docs/contributors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,3 +19,4 @@ Contributors include:
- Alexander Held
- Karthikeyan Singaravelan
- Marco Gorelli
- Pradyumna Rahul K
4 changes: 2 additions & 2 deletions src/pyhf/infer/mle.py
Original file line number Diff line number Diff line change
Expand Up @@ -131,8 +131,8 @@ def fixed_poi_fit(
Run a maximum likelihood fit with the POI value fixed.
This is done by minimizing the objective function of :func:`~pyhf.infer.mle.twice_nll`
of the model parameters given the observed data, for a given fixed value of :math:`\mu`.
This is used to produce the constrained maximal likelihood for the given :math:`\mu`
:math:`L\left(\mu, \hat{\hat{\boldsymbol{\theta}}}\right)` in the profile
This is used to produce the constrained maximal likelihood for the given :math:`\mu`,
:math:`L\left(\mu, \hat{\hat{\boldsymbol{\theta}}}\right)`, in the profile
likelihood ratio in Equation (7) in :xref:`arXiv:1007.1727`
.. math::
Expand Down

0 comments on commit 4b85957

Please sign in to comment.