-
-
Notifications
You must be signed in to change notification settings - Fork 26k
[MRG + 1 (rv) + 1 (alex) + 1] Add a check to test the docstring params and their order #9206
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.
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
Changes from all commits
Commits
Show all changes
77 commits
Select commit
Hold shift + click to select a range
3ae41ff
add test script to have docstrings consistent with function signatures
agramfort 3a1b925
fix docstrings in datasets
agramfort 04da883
add tests
agramfort 00ebcfc
update travis
agramfort 0b2c0eb
refactor
agramfort 5495e0e
make travis happy?
agramfort f3cefca
do not crash when y=None for API reason
agramfort a755044
more fixes
agramfort 9fa05d8
more on metrics module
agramfort f3d9c11
more
agramfort 42b2a2d
more
agramfort 98686e4
more
agramfort 46abcd8
more
agramfort 27936f4
more
agramfort 88c71f3
more
agramfort c0a0630
more
agramfort d48d425
more
agramfort cd36d2d
more
agramfort 4183f6a
more
agramfort a15459d
more
agramfort 9a6f01d
more
agramfort ed1a350
Merge master
raghavrv 48f7433
Merge pull request #15 from raghavrv/test_docstring_params
agramfort b93b4cc
Merge branch 'master' into test_docstring
raghavrv 440231f
Merge branch 'master' into test_docstring
raghavrv d098674
No need of TEST_DOCSTRING='false'
raghavrv a1bbd53
Flake8 and licence
raghavrv b092418
Add Alex's name to the authors
raghavrv 5a104ca
Moving docstring parameter test to sklearn/tests
raghavrv 1f51107
Try fixing some of the inconsistencies
raghavrv c093014
Remove 'optional' to keep it under 80chars
raghavrv 575b243
Address flake8 in least_angle.py
raghavrv 3e2d837
Fix more inconsistencies
raghavrv 8b8ce12
Fix rest of the inconsistencies
raghavrv da187d5
Merge branch 'master' into test_docstring
raghavrv bb554c7
Fix rest of the docstrings; Add debug statements
raghavrv 9ba1682
Collapse the two Notes section into one
raghavrv 8ab87a9
Print class names properly even for decorated class methods
raghavrv 6bb55fb
Fix doc inconsistencies in ExtraTree*
raghavrv e92b1b8
Add some debug statements
raghavrv 7d456a7
Test only on python3.5
raghavrv 140bbb7
Remove debug statements
raghavrv b71fe7e
Fix flake8
raghavrv 657dca9
Fix up Olivier's comments; Add TODO comment
raghavrv ecf22f3
Add ignore warnings
raghavrv d308257
TST also check for incorrect parameter type definitions
raghavrv f65861a
ENH Distinguish between no space before colon and empty type definition
raghavrv 9d95cf8
Merge branch 'master' into test_docstring
raghavrv 0cf439d
TST the test functions ;)
raghavrv 57e4109
Fix new doc inconsistencies after merging with master
raghavrv ac8ecfd
FIX doc param definition inconsistencies
raghavrv d619987
MERGE with latest master
raghavrv 70317cd
FIX error message to include sag
raghavrv 89a2b0e
Fix incorrect merge
raghavrv efd4a8d
FIX remove assert_true
raghavrv a8f281c
Use walk_packages to find the modules to check docstrings in
raghavrv e7f61c7
ENH Automatically identify deprecated classes/methods/functions
raghavrv dffc5fc
ENH add _is_deprecated and tests for the same in utils
raghavrv 6788174
TST Use importlib
raghavrv 0e2c56a
FIX address Andy's comments
raghavrv 11bc8c0
ENH Use symmetric_difference for comparison
raghavrv aaa6770
Address Andy's comments
raghavrv fcf5538
Skip test for builds which have python <= 3.5
raghavrv 6319bf6
Skip both tests
raghavrv d3ab240
Make _is_deprecated work in python2.7
raghavrv e4e1f6c
FIX up the tests to include predict_log_proba
raghavrv c4c30fe
Fix typo in _is_deprecated logic
raghavrv fe54c93
FIX tests shouldn't separately test for __call__. It's included while…
raghavrv e1bc4c1
Remove redundant _DOC_SPECIAL_MEMBERS
raghavrv 1465605
Skip _is_deprecated and it's tests for < python3.5
raghavrv 631d0c5
Flake8
raghavrv ff2bf8c
Merge branch 'master' into test_docstring
raghavrv 5b19ae8
Merge branch 'master' into test_docstring
jnothman f5192da
ENH address joel's comments
raghavrv cb25e5e
Merge branch 'test_docstring' of github.com:raghavrv/scikit-learn int…
raghavrv 7e3e2ca
Address the rest of the comments
raghavrv ed2f75d
Merge branch 'master' into test_docstring
raghavrv File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -312,6 +312,9 @@ def linkage_tree(X, connectivity=None, n_components=None, | |
be symmetric and only the upper triangular half is used. | ||
Default is None, i.e, the Ward algorithm is unstructured. | ||
|
||
n_components : int (optional) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This parameter is unused. See #9307 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. (You don't want this addressed in this PR right?) |
||
The number of connected components in the graph. | ||
|
||
n_clusters : int (optional) | ||
Stop early the construction of the tree at n_clusters. This is | ||
useful to decrease computation time if the number of clusters is | ||
|
@@ -596,14 +599,6 @@ class AgglomerativeClustering(BaseEstimator, ClusterMixin): | |
n_clusters : int, default=2 | ||
The number of clusters to find. | ||
|
||
connectivity : array-like or callable, optional | ||
Connectivity matrix. Defines for each sample the neighboring | ||
samples following a given structure of the data. | ||
This can be a connectivity matrix itself or a callable that transforms | ||
the data into a connectivity matrix, such as derived from | ||
kneighbors_graph. Default is None, i.e, the | ||
hierarchical clustering algorithm is unstructured. | ||
|
||
affinity : string or callable, default: "euclidean" | ||
Metric used to compute the linkage. Can be "euclidean", "l1", "l2", | ||
"manhattan", "cosine", or 'precomputed'. | ||
|
@@ -615,6 +610,14 @@ class AgglomerativeClustering(BaseEstimator, ClusterMixin): | |
By default, no caching is done. If a string is given, it is the | ||
path to the caching directory. | ||
|
||
connectivity : array-like or callable, optional | ||
Connectivity matrix. Defines for each sample the neighboring | ||
samples following a given structure of the data. | ||
This can be a connectivity matrix itself or a callable that transforms | ||
the data into a connectivity matrix, such as derived from | ||
kneighbors_graph. Default is None, i.e, the | ||
hierarchical clustering algorithm is unstructured. | ||
|
||
compute_full_tree : bool or 'auto' (optional) | ||
Stop early the construction of the tree at n_clusters. This is | ||
useful to decrease computation time if the number of clusters is | ||
|
@@ -766,14 +769,6 @@ class FeatureAgglomeration(AgglomerativeClustering, AgglomerationTransform): | |
n_clusters : int, default 2 | ||
The number of clusters to find. | ||
|
||
connectivity : array-like or callable, optional | ||
Connectivity matrix. Defines for each feature the neighboring | ||
features following a given structure of the data. | ||
This can be a connectivity matrix itself or a callable that transforms | ||
the data into a connectivity matrix, such as derived from | ||
kneighbors_graph. Default is None, i.e, the | ||
hierarchical clustering algorithm is unstructured. | ||
|
||
affinity : string or callable, default "euclidean" | ||
Metric used to compute the linkage. Can be "euclidean", "l1", "l2", | ||
"manhattan", "cosine", or 'precomputed'. | ||
|
@@ -785,6 +780,14 @@ class FeatureAgglomeration(AgglomerativeClustering, AgglomerationTransform): | |
By default, no caching is done. If a string is given, it is the | ||
path to the caching directory. | ||
|
||
connectivity : array-like or callable, optional | ||
Connectivity matrix. Defines for each feature the neighboring | ||
features following a given structure of the data. | ||
This can be a connectivity matrix itself or a callable that transforms | ||
the data into a connectivity matrix, such as derived from | ||
kneighbors_graph. Default is None, i.e, the | ||
hierarchical clustering algorithm is unstructured. | ||
|
||
compute_full_tree : bool or 'auto', optional, default "auto" | ||
Stop early the construction of the tree at n_clusters. This is | ||
useful to decrease computation time if the number of clusters is | ||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
omg we're using actual numpydoc! Horray!