Skip to content

DOC Add link to plot_lasso_coordinate_descent_path in lasso_path docstring(#30621)#31616

Closed
VirenPassi wants to merge 8 commits intoscikit-learn:mainfrom
VirenPassi:doc-add-link-plot-lasso-coordinate-descent-path-30621
Closed

DOC Add link to plot_lasso_coordinate_descent_path in lasso_path docstring(#30621)#31616
VirenPassi wants to merge 8 commits intoscikit-learn:mainfrom
VirenPassi:doc-add-link-plot-lasso-coordinate-descent-path-30621

Conversation

@VirenPassi
Copy link
Copy Markdown
Contributor

This PR adds a reference link to the example script
plot_lasso_coordinate_descent_path.py in the lasso_path docstring.

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!

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 21, 2025

✔️ Linting Passed

All linting checks passed. Your pull request is in excellent shape! ☀️

Generated for commit: 7780d57. Link to the linter CI: here

@VirenPassi VirenPassi force-pushed the doc-add-link-plot-lasso-coordinate-descent-path-30621 branch from 1cd2eb8 to 906d6c6 Compare June 21, 2025 10:55
@VirenPassi
Copy link
Copy Markdown
Contributor Author

VirenPassi commented Jun 21, 2025

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?
(I'm happy to help fix the root docstring if needed.)

@thomasjpfan @jeremiedbb @adrinjalali


For a visual example of computing and plotting the Lasso coordinate
descent path, see:
:ref:`sphx_glr_auto_examples_linear_model_plot_lasso_coordinate_descent_path`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

this example is now removed from our gallery. But thanks for the PR.

@adrinjalali adrinjalali closed this Aug 7, 2025
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