Skip to content

Commit

Permalink
Tiny minor change on docstring (#126)
Browse files Browse the repository at this point in the history
  • Loading branch information
dachengx authored Jan 2, 2024
1 parent 6e54724 commit c8b1910
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 11 deletions.
2 changes: 1 addition & 1 deletion alea/model.py
Original file line number Diff line number Diff line change
Expand Up @@ -260,7 +260,7 @@ def get_expectation_values(self, **parameter_values):
def nominal_expectation_values(self):
"""Nominal expectation values for the sources of the likelihood.
For this to work, you must implement `get_expectation_values`.
For this to work, you must implement ``get_expectation_values``.
"""
return self.get_expectation_values() # no kwargs for nominal
Expand Down
4 changes: 2 additions & 2 deletions alea/models/blueice_extended_model.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
class BlueiceExtendedModel(StatisticalModel):
"""A statistical model based on blueice likelihoods.
This class extends the `StatisticalModel` class and provides methods
This class extends the ``StatisticalModel`` class and provides methods
for generating data and computing likelihoods based on blueice.
Attributes:
Expand Down Expand Up @@ -127,7 +127,7 @@ def data(self, data: Union[dict, list]):

def get_source_name_list(self, likelihood_name: str) -> list:
"""Return a list of source names for a given likelihood term. The order is the same as used
in the `source` column of the data, so this can be used to map the indices provided in the
in the ``source`` column of the data, so this can be used to map the indices provided in the
data to a source name.
Args:
Expand Down
2 changes: 1 addition & 1 deletion alea/parameters.py
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ def nominal_value(self, value: Optional[float]) -> None:

@property
def needs_reinit(self) -> bool:
"""Return True if the parameter needs re-initialization (for ptype `needs_reinit`)."""
"""Return True if the parameter needs re-initialization (for ptype ``needs_reinit``)."""
needs_reinit = False
if self.ptype == "needs_reinit":
needs_reinit = True
Expand Down
1 change: 1 addition & 0 deletions docs/make_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@
make clean
rm -r source/reference
sphinx-apidoc -o source/reference ../alea
rm source/reference/modules.rst
make html #SPHINXOPTS="-W --keep-going -n"
7 changes: 0 additions & 7 deletions docs/source/reference/modules.rst

This file was deleted.

0 comments on commit c8b1910

Please sign in to comment.