Thanks to visit codestin.com
Credit goes to github.com

Skip to content

DOC Ensure completeness_score passes numpydoc validation #23016

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
Apr 1, 2022
Merged

DOC Ensure completeness_score passes numpydoc validation #23016

merged 5 commits into from
Apr 1, 2022

Conversation

aj-white
Copy link
Contributor

@aj-white aj-white commented Apr 1, 2022

Reference Issues/PRs

Address #21350

What does this implement/fix? Explain your changes.

  1. Remove sklearn.metrics.cluster._supervised.completeness_score from test_doctrings.py FUNCTION_DOCSTRING_IGNORE_LIST
  2. Fix the following
  • GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, See Also, References, Examples
  • SS05: Summary must start with infinitive verb, not third person (e.g. use "Generate" instead of "Generates")
  • PR08: Parameter "labels_true" description should start with a capital letter
  • PR09: Parameter "labels_true" description should finish with "."
  • PR08: Parameter "labels_pred" description should start with a capital letter
  • PR09: Parameter "labels_pred" description should finish with "."
  • RT04: Return value description should start with a capital letter
  • RT05: Return value description should finish with "."
  • SA04: Missing description for See Also "homogeneity_score" reference
  • SA04: Missing description for See Also "v_measure_score" reference

Any other comments?

@jeremiedbb jeremiedbb added No Changelog Needed Quick Review For PRs that are quick to review labels Apr 1, 2022
@aj-white aj-white changed the title Numpydoc completeness score DOC Ensure completeness_score passes numpydoc validation Apr 1, 2022
jeremiedbb
jeremiedbb approved these changes Apr 1, 2022
View reviewed changes
Copy link
Member

@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks @aj-white

thomasjpfan
thomasjpfan approved these changes Apr 1, 2022
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! LGTM

@thomasjpfan thomasjpfan merged commit 59428da into scikit-learn:main Apr 1, 2022
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Apr 6, 2022
@aj-white @glemaitre
DOC Ensure completeness_score passes numpydoc validation (scikit-lear…
a4220d5 
…n#23016)
@aj-white aj-white deleted the numpydoc_completeness_score branch April 10, 2022 19:08
jjerphan pushed a commit to jjerphan/scikit-learn that referenced this pull request Apr 29, 2022
@aj-white @jjerphan
DOC Ensure completeness_score passes numpydoc validation (scikit-lear…
8685fed 
…n#23016)
@thomasjpfan thomasjpfan mentioned this pull request May 5, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@thomasjpfan thomasjpfan thomasjpfan approved these changes

@jeremiedbb jeremiedbb jeremiedbb approved these changes

Assignees
No one assigned
Labels
Documentation module:metrics No Changelog Needed Quick Review For PRs that are quick to review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@aj-white @thomasjpfan @jeremiedbb