Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Fix numpydoc section name Return -> Returns #17879

Merged
merged 1 commit into from Jul 11, 2020

Conversation

Carreau
Copy link
Contributor

@Carreau Carreau commented Jul 10, 2020

From a cursory glance this is the only place I found in sklearn (and to a wider extend scipy/numpy) that uses Return instead of Returns as described in the numpydoc format.

From a cursory glance this is the only place I found in sklearn (and to a wider extend scipy/numpy) that uses Return instead of Returns as described in the numpydoc format.
@rth
Copy link
Member

rth commented Jul 10, 2020

Thanks @Carreau! There are a few more occurrences I think,

$ rg -U "Return\n\s+---" sklearn/
sklearn/mixture/_bayesian_mixture.py
53:    Return
54:    ------

sklearn/neighbors/_quad_tree.pyx
411:        Return
412:        ------

sklearn/tree/_criterion.pyx
192:        Return
193:        ------

sklearn/ensemble/_hist_gradient_boosting/binning.py
43:    Return
44:    ------

would you like to fix them as well?

@Carreau
Copy link
Contributor Author

Carreau commented Jul 10, 2020

Ok, I need to be more careful with my grep-foo. I'll try to come around and fix those as well.

@GaelVaroquaux
Copy link
Member

This is ready to merge. Should we merge this as is, and @Carreau can do another PR to finish?

I have this in mind in the interest of merging fast and decreasing the number of open PR.

@thomasjpfan thomasjpfan merged commit 38378cb into scikit-learn:master Jul 11, 2020
@Carreau
Copy link
Contributor Author

Carreau commented Jul 11, 2020

I have this in mind in the interest of merging fast and decreasing the number of open PR.

Thanks, I went down the rabbit hole of writing a tool that does auto formatting of docstrings, will send another PR later.

@Carreau Carreau deleted the patch-1 branch July 17, 2020 22:10
jayzed82 pushed a commit to jayzed82/scikit-learn that referenced this pull request Oct 22, 2020
From a cursory glance this is the only place I found in sklearn (and to a wider extend scipy/numpy) that uses Return instead of Returns as described in the numpydoc format.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants