Skip to content

DOC Ensures that SpectralBiclustering passes numpydoc validation #21393

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.

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

Merged
merged 1 commit into from
Oct 22, 2021

Conversation

g4brielvs
Copy link
Contributor

@g4brielvs g4brielvs commented Oct 21, 2021

Reference Issues/PRs

Addresses #20308

What does this implement/fix? Explain your changes.

This PR ensures SpectralBiclustering is compatible with numpydoc.

  • Remove SpectralBiclustering from:
    "SpectralBiclustering",
  • Create See Also section and add SpectralCoclustering.
  • Add Returns to docstring.
  • Minor style fixes (remove double line break, section order)

Any other comments?

Thanks #DataUmbrella! Thanks so much @glemaitre for so patiently reviewing my PRs! Please let me know if there is anything I can do to improve my future PRs and help scikit-learn.

Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

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

LGTM!

@ogrisel ogrisel merged commit 0b46d03 into scikit-learn:main Oct 22, 2021
@ogrisel
Copy link
Member

ogrisel commented Oct 22, 2021

I merged too quickly with realizing there was a linting error. Let me fix it.

@g4brielvs
Copy link
Contributor Author

g4brielvs commented Oct 22, 2021

@ogrisel Thank you so much for reviewing the PR! So sorry for the trailing whitespace.

@glemaitre glemaitre mentioned this pull request Oct 23, 2021
10 tasks
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Oct 23, 2021
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
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