DOC Ensures that DummyRegressor passes numpydoc validation #20394

caherrera-meli · 2021-06-26T19:46:23Z

Reference Issues/PRs

Addresses #20308 for DummyRegressor with my pair programming partner @gloriamacia
What does this implement/fix? Explain your changes.

Addressed errors:

"SS06": "Summary should fit in a single line"
*"SA01": "See Also section not found"
"SS05": "Summary must start with infinitive verb, not third person "
'(e.g. use "Generate" instead of "Generates")'

#DataUmbrella sprint

sklearn/dummy.py

glemaitre

I mark as request changes to see that we reviewed the PR.

Could you try to merge main into your branch and run black formatting on _dummy.py. The error reported by the CI is strange but we can check if something changed.

caherrera-meli · 2021-07-04T17:39:06Z

I mark as request changes to see that we reviewed the PR.

Could you try to merge main into your branch and run black formatting on _dummy.py. The error reported by the CI is strange but we can check if something changed.
We did git rebase with the upstream main branch and we were some commits behind so a lot of files seem to have changed but we only modified dummy.py and test_docstrings.py

glemaitre · 2021-07-06T08:38:35Z

We did git rebase with the upstream main branch and we were some commits behind so a lot of files seem to have changed but we only modified dummy.py and test_docstrings.py

You should not rebase, it makes the conflicts quite difficult and since we are squashing the commits at the end, git merge upstream/main will make your life easier. I will try to solve the issue in your PR.

glemaitre

So it should be OK now. I will wait that the CIs passes to be sure.

glemaitre · 2021-07-06T09:28:21Z

Thanks @caherrera-meli

…arn#20394) Co-authored-by: Guillaume Lemaitre <[email protected]>

Fixing documentation for DummyRegressor

a71fc34

github-actions bot added the Documentation label Jun 26, 2021

thomasjpfan mentioned this pull request Jun 26, 2021

Ensure that docstrings pass numpydoc validation #20308

Closed

glemaitre reviewed Jun 26, 2021

View reviewed changes