Skip to content

DOC Ensures that sklearn.feature_extraction.image.img_to_graph passes numpydoc validation#23398

Merged
jeremiedbb merged 4 commits intoscikit-learn:mainfrom
boraxpr:main
May 17, 2022
Merged

DOC Ensures that sklearn.feature_extraction.image.img_to_graph passes numpydoc validation#23398
jeremiedbb merged 4 commits intoscikit-learn:mainfrom
boraxpr:main

Conversation

@boraxpr
Copy link
Copy Markdown
Contributor

@boraxpr boraxpr commented May 17, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

  1. SS03 : Line 142 : Add a period after summary.
  2. PR09 : Line 161: Add a period after "dtype" description.
  3. RT01 : Line 163: Add a returns section.

Any other comments?

boraxpr added 2 commits May 17, 2022 20:39
Remove "sklearn.feature_extraction.image.img_to_graph" from sklearn.tests.test_docstrings.py FUNCTION_DOCSTRING_IGNORE_LIST
line 142: SS03 : Summary does not end with a period.
line 161: PR09 : Param "dtype" desc. should finish with "."
line 163: RT01 : No Returns section Found.
Copy link
Copy Markdown
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.

Thanks for the PR @boraxpr.

boraxpr and others added 2 commits May 18, 2022 00:38
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
@jeremiedbb jeremiedbb merged commit b1a936d into scikit-learn:main May 17, 2022
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request May 19, 2022
…n#23398)

Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
glemaitre pushed a commit that referenced this pull request May 19, 2022
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
lesteve pushed a commit to lesteve/scikit-learn that referenced this pull request May 19, 2022
…n#23398)

Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants