Skip to content

Explicit docstrings for DecisionTreeClassifier.fit and DecisionTreeRegressor.fit #7809

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

Closed
amueller opened this issue Nov 1, 2016 · 7 comments · Fixed by #7824
Closed

Explicit docstrings for DecisionTreeClassifier.fit and DecisionTreeRegressor.fit #7809

amueller opened this issue Nov 1, 2016 · 7 comments · Fixed by #7824
Labels
Documentation Easy Well-defined and straightforward way to resolve

Comments

@amueller
Copy link
Member

amueller commented Nov 1, 2016

As pointed out in #7801 the docstring for the decision tree fit is a bit vague (because it's shared). I think it would be better if they had separate, precise docstrings.

@chiangqiqi
Copy link

The DecisionTreeRegressor and DecisionTreeClassifier shares the fit function docstring in BaseDecisionTree.fit, how to separate the doc string?

@jnothman
Copy link
Member

jnothman commented Nov 2, 2016

cleanest way writes a new fit in each that calls super.

On 3 November 2016 at 01:00, alexjiang notifications@github.com wrote:

The DecisionTreeRegressor and DecisionTreeClassifier shares the fit
function docstring in BaseDecisionTree.fit, how to separate the doc
string?


You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
#7809 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAEz65is3DXkFxC5BDdC9K4rD0Igu83Tks5q6JeVgaJpZM4KmeIA
.

@amueller
Copy link
Member Author

amueller commented Nov 2, 2016

That's what I though. @jnothman that's not overkill, is it? I think docs are important.

@jnothman
Copy link
Member

jnothman commented Nov 2, 2016

not overkill, no. easier to read in the code too

On 3 November 2016 at 06:57, Andreas Mueller notifications@github.com
wrote:

That's what I though. @jnothman https://github.com/jnothman that's not
overkill, is it? I think docs are important.


You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
#7809 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAEz6-Qtud3ggGhh1TV_Ucj87EzS_WCuks5q6OsigaJpZM4KmeIA
.

@dalmia
Copy link
Contributor

dalmia commented Nov 4, 2016

Hi, I would like to take up the issue.

@dalmia
Copy link
Contributor

dalmia commented Nov 4, 2016

Should both the fit functions have any change in the docString from the one in the BaseDecisionTree.fit() function?

@dalmia
Copy link
Contributor

dalmia commented Nov 12, 2016

Please close this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Easy Well-defined and straightforward way to resolve
Projects
None yet
5 participants