Add reference to biclustering example in biclustering.rst documentation #31393
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sidrtx
approved these changes
May 20, 2025
This was referenced May 21, 2025
StefanieSenger
suggested changes
May 22, 2025
There was a problem hiding this comment.
Hi @Soumyaatanna, thanks for your PR. There are a few problems here, however, that need to be addressed:
- the example is called plot_bicluster_newsgroups, not plot_biclustering_newsgroups
- the formatting of the example is wrong (lacking indent in the beginning is causing CI to fail)
- the location to put the example is arbitrary and not specific (see issue description for how it should be)
Would you mind to go back and fix these things?
|
@sidrtx: Your review wasn't helpful. If you're unsure about the standards or specifics of the issue, it's better to avoid leaving approvals that might mislead contributors or maintainers. Please be more cautious in the future. |
|
Apologies for the oversight regarding the example name and formatting. I'll be more attentive in future reviews to ensure alignment with project guidelines. I truly appreciate your guidance on maintaining documentation standards. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Reference Issues/PRs
What does this implement/fix? Explain your changes.
Any other comments?
#30621
This PR improves the documentation for the biclustering module by adding a reference to the corresponding example script located in the examples/ directory.
Specifically:
Added a link to the plot_bicluster_newsgroups.py example in biclustering.rst
This helps users quickly access a runnable example, improving the learnability and usability of the module
This change follows the standard documentation guidelines for cross-linking examples and enhances the overall developer experience.