Skip to content

DOC Ensures that Birch passes numpydoc validation #20972

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 2 commits into from
Sep 8, 2021
Merged

DOC Ensures that Birch passes numpydoc validation #20972

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c240a33
`Birch` removed from `DOCSTRING_IGNORE_LIST` in test_docstrings.py
baam25simo Sep 8, 2021
a8419b4
In `Birch`: period added in deprecated `fit_` and `partial_fit_` summ…
baam25simo Sep 8, 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
1 change: 0 additions & 1 deletion maint_tools/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@

# List of modules ignored when checking for numpydoc validation.
DOCSTRING_IGNORE_LIST = [
"Birch",
"GammaRegressor",
"GaussianProcessRegressor",
"GaussianRandomProjection",
Expand Down
4 changes: 2 additions & 2 deletions sklearn/cluster/_birch.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -480,7 +480,7 @@ def __init__(
# TODO: Remove in 1.2
# mypy error: Decorated property not supported
@deprecated( # type: ignore
"`fit_` is deprecated in 1.0 and will be removed in 1.2"
"`fit_` is deprecated in 1.0 and will be removed in 1.2."
)
@property
def fit_(self):
Expand All @@ -489,7 +489,7 @@ def fit_(self):
# TODO: Remove in 1.2
# mypy error: Decorated property not supported
@deprecated( # type: ignore
"`partial_fit_` is deprecated in 1.0 and will be removed in 1.2"
"`partial_fit_` is deprecated in 1.0 and will be removed in 1.2."
)
@property
def partial_fit_(self):
Expand Down