Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
jackaraz committed Jul 11, 2024
1 parent 8bd98ec commit 4e5a02e
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions src/spey_pyhf/helper_functions.py
Original file line number Diff line number Diff line change
Expand Up @@ -245,6 +245,8 @@ def remove_channel(self, channel_name: Text) -> None:
"""
Remove channel from the likelihood
.. versionadded:: 0.1.5
Args:
channel_name (``Text``): name of the channel to be removed
"""
Expand All @@ -260,7 +262,12 @@ def remove_channel(self, channel_name: Text) -> None:

@property
def remove_list(self) -> List[Text]:
"""Channels to be removed from the model"""
"""
Channels to be removed from the model
.. versionadded:: 0.1.5
"""
return self._to_remove

def patch_to_map(
Expand All @@ -276,7 +283,9 @@ def patch_to_map(
Args:
signal_patch (``List[Dict]``): JSONPatch for the signal
return_remove_list (``bool``): Inclure channels to be removed in the output
return_remove_list (``bool``, default ``False``): Inclure channels to be removed in the output
.. versionadded:: 0.1.5
Returns:
``Tuple[Dict[Text, Dict], List[Text]]`` or ``Dict[Text, Dict]``:
Expand Down

0 comments on commit 4e5a02e

Please sign in to comment.