-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
DOC Add link to examples_manifold_plot_compare_methods.py to manifold.MDS docstring #29714
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
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
adrinjalali
approved these changes
Aug 26, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like your suggestions @davidcherney
ArturoAmorQ
approved these changes
Aug 27, 2024
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That blank space is creating a weird behavior in the render. But otherwise LGTM. Thanks @davidcherney :)
MarcBresson
pushed a commit
to MarcBresson/scikit-learn
that referenced
this pull request
Sep 2, 2024
glemaitre
pushed a commit
to glemaitre/scikit-learn
that referenced
this pull request
Sep 9, 2024
glemaitre
pushed a commit
that referenced
this pull request
Sep 11, 2024
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.
References issue #26927.
This PR aims to improve documentation by including a link to an example file that compares dimensionality reduction techniques to the doc string of the manifold.MDS class.
Other Comments
Consider the below proposal for
Observations
There is not consensus by maintainers about where in the doc string developers should place links to an example files.
The Developer's Guide says that example files might
The See Also section of doc strings is meant to be a list of FCMs (functions/classes/methods) for similar algorithms.
Personally, I would appreciate finding link to detailed examples in the Examples section of doc strings just below the code snippet examples (in case the code snippets are not enough).
Personally, I would appreciate finding a link to an example file that compares similar algorithms in the doc string just after the list of similar algorithms.
Personally, I do not look for examples OR comparisons in the main section of a doc string; I look there for a simple statement of what the FCM does. (cf. @adrinjalali 's response to @ArturoAmorQ about prominent content.)
Opinion
I would make the following convention for this meta-issue #26927:
Trade-offs