Skip to content

Very old notes in docstrings #28454

@ChVeen

Description

@ChVeen

Describe the issue linked to the documentation

In sklearn/feature_extraction/image.py very old notes are contained in the docstrings of two functions:

https://github.com/scikit-learn/scikit-learn/blob/main/sklearn/feature_extraction/image.py#L178-L185

and

https://github.com/scikit-learn/scikit-learn/blob/main/sklearn/feature_extraction/image.py#L232-L239

These notes refer to scikit-learn 0.14.1 which is approx. 10 years old:

"""
    .
    .
    .
    Notes
    -----
    For scikit-learn versions 0.14.1 and prior, return_as=np.ndarray was
    handled by returning a dense np.matrix instance.  Going forward, np.ndarray
    returns an np.ndarray, as expected.
    .
    .
    .
"""

Maybe these notes are obsolet and can be removed?
What is the employed strategy in scikit-learn regarding such old notes?

Suggest a potential alternative/fix

No response

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