Skip to content

[MRG] DOC ensures that two single_source_shortest_path_length funcs pass numpydoc#24474

Merged
jeremiedbb merged 7 commits intoscikit-learn:mainfrom
seljaks:graph_docstrings
Sep 24, 2022
Merged

[MRG] DOC ensures that two single_source_shortest_path_length funcs pass numpydoc#24474
jeremiedbb merged 7 commits intoscikit-learn:mainfrom
seljaks:graph_docstrings

Conversation

@seljaks
Copy link
Copy Markdown
Contributor

@seljaks seljaks commented Sep 19, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Ensures that sklearn.utils.graph.single_source_shortest_path_length and sklearn.utils.graph.graph_shortest_path pass numpydoc validation. Also minor typo fixes and example improvements.

Any other comments?

sklearn.utils.graph.graph_shortest_path is scheduled for removal in 1.2, so I wasn't as attentive.

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 @seljaks. I think you can just ignore graph_shortest_path since it will be removed soon (I just made a PR to remove it #24478).

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.

LGTM. Thanks @seljaks

@jeremiedbb jeremiedbb merged commit 0aa0f1e into scikit-learn:main Sep 24, 2022
@thomasjpfan thomasjpfan changed the title [MRG] DOC ensures that two sklearn.utils.graph funcs pass numpydoc [MRG] DOC ensures that two single_source_shortest_path_length funcs pass numpydoc Sep 30, 2022
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.

3 participants