Skip to content

DOC Ensures that AgglomerativeClustering passes numpydoc validation #20544

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 45 commits into from
Aug 31, 2021
Merged

DOC Ensures that AgglomerativeClustering passes numpydoc validation #20544

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
7b92e27
initial cleanup: parameters in backticks, spelling, etc
reshamas Jul 16, 2021
cd65b5f
more cleanup: make consistent use of quotes
reshamas Jul 16, 2021
d4d05da
fixing Aggl - Clust errors
reshamas Jul 16, 2021
175c3ba
changing default of return_distance=False (instead of None)
reshamas Jul 16, 2021
c53fba5
added period after 'Agglomerative Clustering' in class
reshamas Jul 16, 2021
b3d7fa3
remove AgglomerativeClustering from test_docstrings.py file
reshamas Jul 16, 2021
5cd5d8e
missing period for X parameter, line 380
reshamas Jul 16, 2021
b402366
formatting, for consistency
reshamas Jul 16, 2021
e57dceb
Update sklearn/cluster/_agglomerative.py
reshamas Jul 20, 2021
cff46d1
Update sklearn/cluster/_agglomerative.py
reshamas Jul 20, 2021
fe90070
Update sklearn/cluster/_agglomerative.py
reshamas Jul 20, 2021
6f8f12f
Merge branch 'main' of github.com:scikit-learn/scikit-learn into Aggl…
reshamas Jul 20, 2021
cf0a476
Merge branch 'AgglomerativeClustering' of https://github.com/reshamas…
reshamas Jul 20, 2021
cec6bcd
remove `FeatureAgglomeration` from test_docstrings.py
reshamas Jul 20, 2021
f0c4764
change linkage options from single to double quotes
reshamas Jul 20, 2021
876502b
for linkage parameter, change quotes from single to double
reshamas Jul 20, 2021
902a14f
removed unnecessary period; added a period in def function
reshamas Jul 20, 2021
10f4b0e
fixed missing periods in _feature_agglomeration.py file
reshamas Jul 20, 2021
7c1aef6
Merge branch 'main' into AgglomerativeClustering
glemaitre Jul 21, 2021
327cb22
formatting changes
reshamas Jul 23, 2021
82d2f9b
?fixing merge conflicts
reshamas Jul 27, 2021
9a2aa55
Merge branch 'main' of github.com:scikit-learn/scikit-learn into Aggl…
reshamas Jul 27, 2021
2d15865
Merge branch 'main' of github.com:scikit-learn/scikit-learn into Aggl…
reshamas Jul 27, 2021
994303d
test_docstrings.py merge conflict
reshamas Jul 27, 2021
6dbf04b
fix merge conflicts in test_docstrings.py
reshamas Jul 27, 2021
682b3a9
adding in parameters docstring
reshamas Jul 28, 2021
527adbd
Merge branch 'main' of github.com:scikit-learn/scikit-learn into Aggl…
reshamas Jul 28, 2021
e17ba51
trying to fix docstring error
reshamas Jul 28, 2021
95fadab
removed two classes from test_docstrings.py
reshamas Jul 28, 2021
3675bd3
ran black on _agglomerative.py
reshamas Jul 28, 2021
4006aec
remove AdditiveChi2Sampler and FastICA from test_docstrings.py
reshamas Jul 28, 2021
738959e
Merge branch 'main' of github.com:scikit-learn/scikit-learn into Aggl…
reshamas Jul 30, 2021
261063b
removed duplicate text for docstring for def fit
reshamas Jul 30, 2021
5f5bfd0
edit docstring so it is only one line
reshamas Jul 30, 2021
52ca7f0
Merge branch 'main' of github.com:scikit-learn/scikit-learn into Aggl…
reshamas Aug 2, 2021
296aa0c
line 907: removing shape of n_samples by n_samples, doesn t seem right
reshamas Aug 2, 2021
a11aad3
try (n_samples,)
reshamas Aug 2, 2021
59d960e
yes, it should be (n_samples, n_samples)!
reshamas Aug 2, 2021
79dd561
added docstring to @property of def fit_predict
reshamas Aug 2, 2021
9e9a776
ran black on _agglomerative.py
reshamas Aug 2, 2021
dcd1a53
Merge branch 'main' of github.com:scikit-learn/scikit-learn into Aggl…
reshamas Aug 8, 2021
45e7c22
Merge branch 'main' of github.com:scikit-learn/scikit-learn into Aggl…
reshamas Aug 20, 2021
60df0b9
small changes
glemaitre Aug 31, 2021
6179494
Merge remote-tracking branch 'origin/main' into pr/reshamas/20544
glemaitre Aug 31, 2021
1bf2e36
Merge branch 'main' into AgglomerativeClustering
glemaitre Aug 31, 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
2 changes: 0 additions & 2 deletions maint_tools/test_docstrings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,8 @@

# List of modules ignored when checking for numpydoc validation.
DOCSTRING_IGNORE_LIST = [
"AgglomerativeClustering",
"BernoulliRBM",
"Birch",
"FeatureAgglomeration",
"FeatureHasher",
"FeatureUnion",
"FunctionTransformer",
Expand Down
Loading