Skip to content

[SPRINT] Enable links to objects in docstrings #17417

@thomasjpfan

Description

@thomasjpfan

Please do not address this issue unless you're part of the sprint (June 6th 2020).

Some docstrings do not link to their objects:

  • sklearn.ensemble.StackingRegressor
  • sklearn.ensemble.StackingClassifer
  • sklearn.ensemble.AdaBoostClassifier
  • sklearn.ensemble.AdaBoostRegressor
  • sklearn.ensemble.BaggingClassifier
  • sklearn.ensemble.BaggingRegressor
  • sklearn.linear_model.RANSACRegressor

For example, the docstring in StackingRegressor do not link to the estimators:

final_estimator : estimator, default=None
A classifier which will be used to combine the base estimators.
The default classifier is a `LogisticRegression`.

This can be linked by setting replacing:

`LogisticRegression`

with:

:class:`~sklearn.linear_model.LogisticRegression`

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions