Skip to content

DOC Ensures that available_if passes numpydoc validation #24586

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

Merged
merged 4 commits into from
Oct 6, 2022
Merged

DOC Ensures that available_if passes numpydoc validation #24586

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
492643d
fix docstring in available_if
irene000 Oct 5, 2022
ea185ab
Merge branch 'main' into validate_docstrings_available_if
irene000 Oct 5, 2022
f95c2aa
Improve docstring of available_if
irene000 Oct 6, 2022
5c585c9
Merge branch 'main' into validate_docstrings_available_if
irene000 Oct 6, 2022
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
1 change: 0 additions & 1 deletion sklearn/tests/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
"sklearn.utils.fixes.threadpool_limits",
"sklearn.utils.gen_batches",
"sklearn.utils.gen_even_slices",
"sklearn.utils.metaestimators.available_if",
"sklearn.utils.metaestimators.if_delegate_has_method",
]
FUNCTION_DOCSTRING_IGNORE_LIST = set(FUNCTION_DOCSTRING_IGNORE_LIST)
Expand Down
8 changes: 7 additions & 1 deletion sklearn/utils/metaestimators.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ def out(*args, **kwargs):


def available_if(check):
"""An attribute that is available only if check returns a truthy value
"""An attribute that is available only if check returns a truthy value.

Parameters
----------
Expand All @@ -150,6 +150,12 @@ def available_if(check):
a truthy value if the attribute is available, and either return False
or raise an AttributeError if not available.

Returns
-------
callable
Callable makes the decorated method available if `check` returns
a truthy value, otherwise the decorated method is unavailable.

Examples
--------
>>> from sklearn.utils.metaestimators import available_if
Expand Down