Skip to content

make sphinx directive about version more sklearn specific #32045

@Remi-Gau

Description

@Remi-Gau

Describe the issue linked to the documentation

This is minor issue mostly affecting the rendering of the documentation of downstream libraries.

For example in Nilearn we use the TransformerMixin in quite a few of our estimators.

But when viewing the doc of our estimators, the sklearn methods of that mixin may have things like 'Added in version 1.3'

https://nilearn.github.io/stable/modules/generated/nilearn.maskers.SurfaceLabelsMasker.html#nilearn.maskers.SurfaceLabelsMasker.set_transform_request

Image

However Nilearn does not have a version 1.3 so this kind of look confusing.

Suggest a potential alternative/fix

I am wondering if it would be possible to mention 'scikit-learn' in the sphinx directives that are about version (added, deprecated...)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions