Skip to content

DOC Ensures that make_sparse_spd_matrix passes numpydoc#22332

Merged
thomasjpfan merged 1 commit intoscikit-learn:mainfrom
Dev514:makes_sparse_spd_matrix
Jan 29, 2022
Merged

DOC Ensures that make_sparse_spd_matrix passes numpydoc#22332
thomasjpfan merged 1 commit intoscikit-learn:mainfrom
Dev514:makes_sparse_spd_matrix

Conversation

@Dev514
Copy link
Copy Markdown
Contributor

@Dev514 Dev514 commented Jan 29, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

This PR fixes the following error that was appearing for numpydoc validation for sklearn.datasets._samples_generator.make_sparse_spd_matrix

  • GL07: Sections are in the wrong order. Correct order is: Parameters, Returns, See Also, Notes
  • PR09: Parameter "norm_diag" description should finish with "."
  • SA04: Missing description for See Also "make_spd_matrix" reference

Any other comments?

Copy link
Copy Markdown
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 @Dev514 ! LGTM

@thomasjpfan thomasjpfan changed the title DOC Ensures that make_sparse_spd_matrix passes numpydoc validation DOC Ensures that make_sparse_spd_matrix passes numpydoc Jan 29, 2022
@thomasjpfan thomasjpfan merged commit bd60c82 into scikit-learn:main Jan 29, 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.

2 participants