DOC Add link to plot_lasso_coordinate_descent_path in lasso_path docstring(#30621) #31616
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
1cd2eb8 to
906d6c6
Compare
|
Hi! I've added a :ref: link to plot_lasso_coordinate_descent_path in the Notes section of the lasso_path docstring, following the conventions used in this file. However, test_function_docstring[lasso_path] keeps failing. I believe this is due to pre-existing formatting issues in the docstring that my change is now surfacing. Can a maintainer help confirm if this docstring should be patched separately or whether it's OK to ignore the failure in this PR? |
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.
This PR adds a reference link to the example script
plot_lasso_coordinate_descent_path.pyin thelasso_pathdocstring.This is part of the documentation improvement initiative in
issue #30621 to better link example scripts to relevant API documentation.
Rendered documentation preview should now include:
"see :ref:
sphx_glr_auto_examples_linear_model_plot_lasso_coordinate_descent_path.py"Thanks!