Skip to content

Commit

Permalink
docs: only lists are accepted when specifying objects to prune (#1692)
Browse files Browse the repository at this point in the history
* Correct Workspace.prune docstrings to indicate lists are accepted
  • Loading branch information
alexander-held authored Nov 11, 2021
1 parent 39a9e92 commit e7c0fce
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions src/pyhf/workspace.py
Original file line number Diff line number Diff line change
Expand Up @@ -485,11 +485,11 @@ def _prune_and_rename(
corresponding `observation`.
Args:
prune_modifiers: A :obj:`str` or a :obj:`list` of modifiers to prune.
prune_modifier_types: A :obj:`str` or a :obj:`list` of modifier types to prune.
prune_samples: A :obj:`str` or a :obj:`list` of samples to prune.
prune_channels: A :obj:`str` or a :obj:`list` of channels to prune.
prune_measurements: A :obj:`str` or a :obj:`list` of measurements to prune.
prune_modifiers: A :obj:`list` of modifiers to prune.
prune_modifier_types: A :obj:`list` of modifier types to prune.
prune_samples: A :obj:`list` of samples to prune.
prune_channels: A :obj:`list` of channels to prune.
prune_measurements: A :obj:`list` of measurements to prune.
rename_modifiers: A :obj:`dict` mapping old modifier name to new modifier name.
rename_samples: A :obj:`dict` mapping old sample name to new sample name.
rename_channels: A :obj:`dict` mapping old channel name to new channel name.
Expand Down Expand Up @@ -622,11 +622,11 @@ def prune(
The pruned workspace must also be a valid workspace.
Args:
modifiers: A :obj:`str` or a :obj:`list` of modifiers to prune.
modifier_types: A :obj:`str` or a :obj:`list` of modifier types to prune.
samples: A :obj:`str` or a :obj:`list` of samples to prune.
channels: A :obj:`str` or a :obj:`list` of channels to prune.
measurements: A :obj:`str` or a :obj:`list` of measurements to prune.
modifiers: A :obj:`list` of modifiers to prune.
modifier_types: A :obj:`list` of modifier types to prune.
samples: A :obj:`list` of samples to prune.
channels: A :obj:`list` of channels to prune.
measurements: A :obj:`list` of measurements to prune.
Returns:
~pyhf.workspace.Workspace: A new workspace object with the specified components removed
Expand Down

0 comments on commit e7c0fce

Please sign in to comment.