8000 DOC Fixes numpydoc validation errors in KNeighborsClassifier by pibieta · Pull Request #20373 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]
Skip to content
  • Insights

    • DOC Fixes numpydoc validation errors in KNeighborsClassifier #20373

    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 5 commits into from
    Jun 28, 2021
    Merged

    DOC Fixes numpydoc validation errors in KNeighborsClassifier #20373

    merged 5 commits into from
    Jun 28, 2021

    Conversation

    @pibieta
    Copy link
    Contributor
    @pibieta pibieta commented Jun 26, 2021

    Reference Issues/PRs

    Addresses #20308

    What does this implement/fix? Explain your changes.

    Fixes numpydoc validation errors in KNeighborsClassifier, namely:

    • Missing See Also descriptions.
    • Added periods.
    • Capital letter at the beginning of descriptions.

    Any other comments?

    #DataUmbrella sprint
    cc: @pibieta @g4brielvs

    @amueller
    Copy link
    Member
    amueller commented Jun 26, 2021

    I think there's a linting issue with a line being too long, I think it might be whitespace?

    glemaitre
    glemaitre reviewed Jun 26, 2021
    View reviewed changes
    glemaitre
    glemaitre reviewed Jun 26, 2021
    View reviewed changes
    glemaitre
    glemaitre reviewed Jun 26, 2021
    View reviewed changes
    glemaitre
    glemaitre approved these changes Jun 26, 2021
    View reviewed changes
    Copy link
    Member
    @glemaitre glemaitre left a comment

    Choose a reason for hiding this comment

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

    LGTM. Let see if the CIs agree ;)

    @thomasjpfan thomasjpfan mentioned this pull request Jun 26, 2021
    Closed
    thomasjpfan
    thomasjpfan reviewed Jun 26, 2021
    View reviewed changes
    Copy link
    Member
    @thomasjpfan thomasjpfan left a comment

    Choose a reason for hiding this comment

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

    Thank you for the PR @pibieta !

    @pibieta @thomasjpfan
    Update sklearn/neighbors/_classification.py
    fd61a77 
    Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
    @pibieta
    Copy link
    Contributor Author
    pibieta commented Jun 26, 2021

    It seems I need an approval for github to run the test on 2 worlkflows. Can you help with that @glemaitre ?

    @glemaitre glemaitre merged commit 03ab582 into scikit-learn:main Jun 28, 2021
    @glemaitre
    Copy link
    Member
    glemaitre commented Jun 28, 2021

    Looks good. Merging. Thanks @pibieta

    samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
    @pibieta @thomasjpfan @samronsin
    DOC Fixes numpydoc validation errors in KNeighborsClassifier (scikit-…
    ffa8150 
    …learn#20373)

Co-authored-by: Thomas J. Fan <thomasjpfan@gmail.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Reviewers

    @thomasjpfan thomasjpfan thomasjpfan left review comments

    @glemaitre glemaitre glemaitre approved these changes

    Assignees

    No one assigned

    Labels

    Documentation module:neighbors

    Projects

    None yet

    Milestone

    No milestone

    Development

    Successfully merging this pull request may close these issues.

    4 participants

    @pibieta @amueller @glemaitre @thomasjpfan
    0