Skip to content

Commit

Permalink
[docs] [dask] Add return information to Dask fit() docs (fixes #4402) (
Browse files Browse the repository at this point in the history
…#4716)

* [docs] [dask] Add return information to Dask fit() docs (fixes #4402)

* put return before note
  • Loading branch information
jameslamb authored Nov 8, 2021
1 parent 560a035 commit 858cc0a
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions python-package/lightgbm/dask.py
Original file line number Diff line number Diff line change
Expand Up @@ -1213,6 +1213,11 @@ def fit(
fit.__doc__ = f"""{_base_doc[:_base_doc.find('callbacks :')]}**kwargs
Other parameters passed through to ``LGBMClassifier.fit()``.
Returns
-------
self : lightgbm.DaskLGBMClassifier
Returns self.
{_lgbmmodel_doc_custom_eval_note}
"""

Expand Down Expand Up @@ -1393,6 +1398,11 @@ def fit(
fit.__doc__ = f"""{_base_doc[:_base_doc.find('callbacks :')]}**kwargs
Other parameters passed through to ``LGBMRegressor.fit()``.
Returns
-------
self : lightgbm.DaskLGBMRegressor
Returns self.
{_lgbmmodel_doc_custom_eval_note}
"""

Expand Down Expand Up @@ -1556,6 +1566,11 @@ def fit(
fit.__doc__ = f"""{_base_doc[:_base_doc.find('callbacks :')]}**kwargs
Other parameters passed through to ``LGBMRanker.fit()``.
Returns
-------
self : lightgbm.DaskLGBMRanker
Returns self.
{_lgbmmodel_doc_custom_eval_note}
"""

Expand Down

0 comments on commit 858cc0a

Please sign in to comment.