Skip to content

DOC Docstring fix for DecisionTreeClassifier and DecisionTreeR… #15483

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

Jump to bottom
Merged
merged 24 commits into from
Nov 5, 2019
Merged

DOC Docstring fix for DecisionTreeClassifier and DecisionTreeR… #15483

merged 24 commits into from
Nov 5, 2019

Conversation

r-build
Copy link
Contributor

@r-build r-build commented Nov 2, 2019 •
edited
Loading

Reference Issues/PRs

Addresses part of issue #15440.

What does this implement/fix? Explain your changes.

Applies numpydoc validation to docstrings for DecisionTreeClassifier and DecisionTreeRegressor, part of issue #15440.

Any other comments?

r-build added 22 commits November 2, 2019 14:16
@r-build
change docstring start to infinitive; change input type to bool
03e0b51
@r-build
Merge remote-tracking branch 'upstream/master' into docstring-fix-DTC
fc07db2
@r-build
Fix .decision_path docstring. Remove blank line before final """; add…
326f62b 
… period at end of summary; change parameter type to bool
@r-build
Fix DTC.fit. Change paramter type to bool; add description to return …
ec4d6a7 
…value
@r-build
Merge remote-tracking branch 'upstream/master' into docstring-fix-DTC
82043fe
@r-build
Fix docstring for DTC.get_depth: Start summary with infinitive; add R…
483e0f1 
…eturns
@r-build
Fix docstring for DTC.get_n_leaves: Start docstring with infinitve; a…
6b59695 
…dd Returns section
@r-build
Merge remote-tracking branch 'upstream/master' into docstring-fix-DTC
40057d0
@r-build
Fxi docstring DTC .predict: change parameter type to bool
bfd63db
@r-build
Fix docstring for DTC .predict_log_proba: Edit first Returns line to …
9d34c45 
…less than 80 chars
@r-build
Fix docstring for DTC .predict_proba: Correct Returns name and line l…
6cc3744 
…ength
@r-build
Fxi docstring for DTC: correct capitalisation to See Also
7c30290
@r-build
fix docstring for DTC: Rremove space after reST deprecated
102eb71
@r-build
fix docstring for DTC: Change parameter type to str
3d7a11d
@r-build
fix docstring for DTC: Change parameter type to str
12d486b
@r-build
Fix docstring for DTC: Added some missing See Also references (not …
12f7fb4 
…all)
@r-build
Fix docstring for DTC: Change parameter type to str
84f7f54
@r-build
Fix docstrings for DTC: Corrected section order (See Also <-> Notes)
45eb157
@r-build
Fix docstring for DTR: remove space between reST deprecated and ::
3b251c6
@r-build
Fix docstring for DTR .fit: Set parameter type to bool; Add Returns…
1689678 
… descriptions
@r-build
Fix docstring for DTR .score: Start docstring summaries with Return…
bb1cd94 
… not `Returns`
@r-build
Merge remote-tracking branch 'upstream/master' into docstring-fix-DTC
b06bfbc
@alexdesiqueira
Copy link

@r-build @rth a part of this PR is also treated at #15479, please mind the overlap 😅

@r-build
Copy link
Contributor Author

r-build commented Nov 2, 2019

@r-build @rth a part of this PR is also treated at #15479, please mind the overlap 😅

Apologies, #15479 wasn't there when I started (hackathon sprint today), and I didn't spot it before making the PR.
There may be overlap but there are definitely non-overlapping parts in each PR. Should be OK for maintainers to merge both?

@alexdesiqueira
Copy link

We were sprinting here as well @r-build :) I'm not sure if we would be able to merge both, but since yours is more complete, I think this one should be preferred instead. Could you close the #15749 then @rth?

rth
rth reviewed Nov 3, 2019
View reviewed changes
@rth
Copy link
Member

rth commented Nov 3, 2019

Thanks @r-build ! LGTM aside from the few comment above.

@alexdesiqueira I merged your earlier PR on this, which made the diff here a bit smaller but didn't create any merge conflicts..

rth
rth approved these changes Nov 5, 2019
View reviewed changes
Copy link
Member

@rth rth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @r-build! LGTM. Merging.

@rth rth changed the title DOC Docstring fix for DecisionTreeClassifier and DecisionTreeRegressor DOC Docstring fix for DecisionTreeClassifier and DecisionTreeR… Nov 5, 2019
@rth rth merged commit 6488110 into scikit-learn:master Nov 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rth rth rth approved these changes

Assignees
No one assigned
Labels
Documentation Sprint
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@r-build @alexdesiqueira @rth