dask / dask/dask-ml

Inconsistent inherited docstrings

Open
#124 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
951
Forks
262
PR merge metrics
No merged PRs in 30d

Description

A few estimators subclass estimators from other ML packages (e.g. scikit-learn) and when a method is not overwritten, the docstring from the parent package is used directly in the documentation, which is not necessarily consistent. For instance,
* docstrings inherited from scikit-learn where [the variable dtype includes sparse arrays](http://dask-ml.readthedocs.io/en/latest/search.html?q=sparse&check_keywords=yes&area=default)
* ["see also" sections](http://dask-ml.readthedocs.io/en/latest/modules/generated/dask_ml.linear_model.PartialPerceptron.html?highlight=sparse) that points to scikit-learn estimators etc.

I wonder if some automatic re-writing of the non-overwritten methods could partially address this...

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.