Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: only lists are accepted when specifying objects to prune #1692

Merged
merged 2 commits into from
Nov 11, 2021
Merged

docs: only lists are accepted when specifying objects to prune #1692

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
967bc46
docs: fix pruning docstrings, only lists are accepted
alexander-held Nov 11, 2021
e176353
Merge branch 'master' into docs/pruning-docstring-lists
matthewfeickert Nov 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions src/pyhf/workspace.py
View file
Open in desktop
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