Skip to content

FIX Uses code literals in deprecated to prevent linking#20410

Merged
glemaitre merged 5 commits intoscikit-learn:mainfrom
thomasjpfan:deprecated_property_sphinx_reference
Jun 28, 2021
Merged

FIX Uses code literals in deprecated to prevent linking#20410
glemaitre merged 5 commits intoscikit-learn:mainfrom
thomasjpfan:deprecated_property_sphinx_reference

Conversation

@thomasjpfan
Copy link
Copy Markdown
Member

Reference Issues/PRs

Follow up to #20385

What does this implement/fix? Explain your changes.

Now that docstrings for properties are exposed, sphinx considers the underscore (_) a link. This PR makes sure all the deprecated messages refer to attributes as literals.

Copy link
Copy Markdown
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

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

LGTM, assuming CI is green after the commit I just pushed.

@glemaitre glemaitre merged commit 383b53f into scikit-learn:main Jun 28, 2021
@glemaitre
Copy link
Copy Markdown
Member

LGTM. Thanks @thomasjpfan

samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
…#20410)

Co-authored-by: Olivier Grisel <olivier.grisel@ensta.org>
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.

3 participants