Skip to content

DOC: Add example link to RidgeClassifier docstring (#30621)#31602

Closed
MauryaGhogare wants to merge 3 commits intoscikit-learn:mainfrom
MauryaGhogare:docs/add-example-links
Closed

DOC: Add example link to RidgeClassifier docstring (#30621)#31602
MauryaGhogare wants to merge 3 commits intoscikit-learn:mainfrom
MauryaGhogare:docs/add-example-links

Conversation

@MauryaGhogare
Copy link
Copy Markdown
Contributor

Reference Issues/PRs

Fixes #30621

What does this implement/fix? Explain your changes.

This PR adds a visual example reference link to the RidgeClassifier docstring in sklearn.linear_model._ridge.

Any other comments?

N/A

@github-actions
Copy link
Copy Markdown

github-actions bot commented Jun 20, 2025

❌ Linting issues

This PR is introducing linting issues. Here's a summary of the issues. Note that you can avoid having linting issues by enabling pre-commit hooks. Instructions to enable them can be found here.

You can see the details of the linting issues under the lint job here


ruff check

ruff detected issues. Please run ruff check --fix --output-format=full locally, fix the remaining issues, and push the changes. Here you can see the detected issues. Note that the installed ruff version is ruff=0.11.7.

Details

sklearn/linear_model/_ridge.py:1513:89: E501 Line too long (89 > 88)
     |
1511 |     0.9595...
1512 |
1513 |     You can find a visual example here: :ref:`example_linear_model_plot_ridge_classifier`
     |                                                                                         ^ E501
     |

Found 1 error.

Generated for commit: d8e840f. Link to the linter CI: here

@MauryaGhogare
Copy link
Copy Markdown
Contributor Author

Hi! This PR adds a small docstring improvement to the RidgeClassifier by linking to a related example.
All linting and most checks have passed, but the ARM lint test failed, which doesn’t seem related to my change.

Kindly let me know if I should do anything further or if a re-run is needed.
Thanks for your time and support!

Copy link
Copy Markdown
Member

@StefanieSenger StefanieSenger left a comment

Choose a reason for hiding this comment

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

Hi @MauryaGhogare,

thank you, but the example plot_ridge_classifier does not exist? 😲
Did you generate this PR with a tool? What did you intend to do?

I'm closing this and am happy to review a new PR that references one of the examples from the issue list.

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.

Add links to examples from the docstrings and user guide

3 participants