Skip to content

DOC Ensures DecisionTreeClassifier passes numpydoc validation #20399

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 4 commits into from
Jun 29, 2021
Merged

DOC Ensures DecisionTreeClassifier passes numpydoc validation #20399

merged 4 commits into from
Jun 29, 2021

Conversation

LucyJimenez
Copy link
Contributor

Reference Issues/PRs

Addresses #20308 for DecisionTreeClassifier with my pair programming partner @eugeniaft

Addressed errors:
"- GL10: reST directives ['deprecated'] must be followed by two colons"

#DataUmbrella sprint

@thomasjpfan thomasjpfan mentioned this pull request Jun 27, 2021
Closed
@glemaitre
Copy link
Member

I think that the warning raised by sphinx are unrelated. I will check.

@ogrisel
Copy link
Member

ogrisel commented Jun 28, 2021

I merged main again to fix the unrelated black linter failure.

ogrisel
ogrisel approved these changes Jun 28, 2021
View reviewed changes
Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

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

LGTM assuming CI will be green this time.

@glemaitre
Copy link
Member

Not sure, you still have the sphinx warning. And I am also thinking that @property numpydoc is not that trivial.
I opened #20414 just to check the sphinx warning issue.

@ogrisel
Copy link
Member

ogrisel commented Jun 28, 2021

Indeed it failed. For the record, here are the new sphinx warnings introduced by this PR:


    sklearn/tree/_classes.py:docstring of sklearn.tree._classes.DecisionTreeClassifier:154: WARNING: Unknown target name: "n_features".
    sklearn/tree/_classes.py:docstring of sklearn.tree.DecisionTreeClassifier.n_features_:2: WARNING: Unknown target name: "n_features".
    sklearn/tree/_classes.py:docstring of sklearn.tree.DecisionTreeClassifier.n_features_:2: WARNING: Unknown target name: "n_features_in".
    sklearn/tree/_classes.py:docstring of sklearn.tree._classes.DecisionTreeRegressor:144: WARNING: Unknown target name: "n_features".
    sklearn/tree/_classes.py:docstring of sklearn.tree.DecisionTreeRegressor.n_features_:2: WARNING: Unknown target name: "n_features".
    sklearn/tree/_classes.py:docstring of sklearn.tree.DecisionTreeRegressor.n_features_:2: WARNING: Unknown target name: "n_features_in".
    sklearn/tree/_classes.py:docstring of sklearn.tree._classes.ExtraTreeClassifier:155: WARNING: Unknown target name: "n_features".
    sklearn/tree/_classes.py:docstring of sklearn.tree.ExtraTreeClassifier.n_features_:2: WARNING: Unknown target name: "n_features".
    sklearn/tree/_classes.py:docstring of sklearn.tree.ExtraTreeClassifier.n_features_:2: WARNING: Unknown target name: "n_features_in".
    sklearn/tree/_classes.py:docstring of sklearn.tree._classes.ExtraTreeRegressor:138: WARNING: Unknown target name: "n_features".
    sklearn/tree/_classes.py:docstring of sklearn.tree.ExtraTreeRegressor.n_features_:2: WARNING: Unknown target name: "n_features".
    sklearn/tree/_classes.py:docstring of sklearn.tree.ExtraTreeRegressor.n_features_:2: WARNING: Unknown target name: "n_features_in".

@ogrisel
Copy link
Member

ogrisel commented Jun 28, 2021

I believe the unknown target warnings will be fixed by #20410.

@ogrisel
Copy link
Member

ogrisel commented Jun 29, 2021

I merged main to check that this will fix the CI.

@ogrisel ogrisel merged commit 338ae8e into scikit-learn:main Jun 29, 2021
@ogrisel
Copy link
Member

ogrisel commented Jun 29, 2021

Thanks @LucyJimenez!

samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
@glemaitre @ogrisel @samronsin
fix docs DecisionTreeClassifier (scikit-learn#20399)
caa70e1 
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ogrisel ogrisel ogrisel approved these changes

Assignees
No one assigned
Labels
Documentation module:tree
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@LucyJimenez @glemaitre @ogrisel