Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

[SPRINT] Enable links to objects in docstrings

See original GitHub issue

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:

https://github.com/scikit-learn/scikit-learn/blob/58168178e76d3f2d8a700b7f87495725399d612f/sklearn/ensemble/_stacking.py#L269-L271

This can be linked by setting replacing:

`LogisticRegression`

with:

:class:`~sklearn.linear_model.LogisticRegression`

Issue Analytics

State:
Created 3 years ago
Comments:12 (8 by maintainers)

Top GitHub Comments

1reaction

alfaro96commented, Jun 9, 2020

Hey @thomasjpfan!

Since all docstrings are already linked to their objects, I think that this issue should be closed.

0reactions

thomasjpfancommented, Jun 9, 2020

Thank you everyone for working on this issue!

Top Results From Across the Web

Link to class method in Python docstring - Stack Overflow

I want to add a link to a method in my class from within the docstring of another method of the same class....

Your first contribution to PyMC

Your first contribution to PyMC#. This tutorial will guide you in submitting your first PR to the pymc repository. We have tried to...

An update on the pandas documentation - Marc Garcia

Some context This post is mainly a technical post on what's the status of the pandas documentation. But let me provide a bit...

doctest — Test interactive Python examples — Python 3.11.1 ...

DocTestFinder : Finds all docstrings in a given module, and uses a DocTestParser to create a DocTest from every docstring that contains interactive...

pandas docstring guide - Python-Sprints

A Python docstring is a string used to document a Python module, class, function or method, ... To display only the last component...