Added utils.gen_batches in documentation, Solving issue #19681 #19688

seanbenhur · Mar 16, 2021

Closes #19681

What does this implement/fix? Explain your changes.

Added utils.gen_batches in documentation file

Any other comments?

My first PR, if I had done any mistake, let me know !

Added utils.gen_batches in documentation, Solving issue #19681

cmarmo

Thanks ~~@seamusabshere~~ @seanbenhur! All checks are green and the search in the rendered documentation contains gen_batches. LGTM!

seanbenhur · Mar 16, 2021

Thanks @cmarmo, I guess you have misspelled my name!

rth

Thanks @seanbenhur and @cmarmo !

rth · Mar 16, 2021

Another thing that would have been great, if you are still interested @seanbenhur is to cross link gen_batches and gen_even_slices by adding a 'See Also' section to each of them and linking to the other function. See an example of such section here.

If not, we can merge this and open a separate PR.

seanbenhur · Mar 16, 2021

Sure @rth, I will work on it

cmarmo

Thanks @seanbenhur ... :) (with the right spelling this time).
I have added suggestions to fix the lint errors

sklearn/utils/__init__.py

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

seanbenhur · Mar 17, 2021

I just committed the suggested change, but it still fails

cmarmo · Mar 17, 2021

You can click on the 'details' link to check the lint error message. Apparently there is still one, indeed:

sklearn/utils/__init__.py:693:1: W293 blank line contains whitespace

seanbenhur · Mar 17, 2021

I apologize, but seeing error messages, it seems I have to change the documentation right!?

cmarmo

I apologize, but seeing error messages, it seems I have to change the documentation right!?

This time is the documentation engine (sphinx) complaining. Blank lines should be kept after the titles. The previous lint error was telling you that some blank spaces were present in a blank line.

sklearn/utils/__init__.py

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

cmarmo · Mar 17, 2021

Sorry @seanbenhur I believe I'm having issues with the suggestions.... there are some blank spaces I can't see: do you mind removing them locally? Thanks!

sklearn/utils/__init__.py

seanbenhur · Mar 17, 2021

Yep, I am currently working on that, Thanks for the support

…

On Wed, 17 Mar 2021, 15:36 Chiara Marmo, ***@***.***> wrote: Sorry @seanbenhur <https://github.com/seanbenhur> I believe I'm having issues with the suggestions.... there are some blank spaces I can't see: do you mind removing them locally? Thanks! — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#19688 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AKKLL6LH6W6TM5PTSUUFPKLTEB5IXANCNFSM4ZIAE2WA> .

sklearn/utils/__init__.py

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

cmarmo · Mar 17, 2021

Yep, I am currently working on that, Thanks for the support

Thanks for your patience! :)

Fix linting

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

sklearn/utils/__init__.py

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

cmarmo · Mar 17, 2021

If it can be useful, here you can find some resources about how to track CI failures.

cmarmo · Mar 17, 2021

sphinx again... you need to add a blank line before the title as shown here.

seanbenhur · Mar 17, 2021

If it can be useful, here you can find some resources about how to track CI failures.

Thank you, its helpful

jeremiedbb

Thanks @seanbenhur. You have 2 linting failures, otherwise lgtm.

sklearn/utils/__init__.py

Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>

cmarmo · Mar 17, 2021

Hi @seanbenhur I think using the github suggestions is no longer a good idea. The issue here is that you need a blank line at lines 693 and 745 in order to avoid sphinx warnings. It seems that each time you add the blank line your editor adds an automatic indentation that makes lint unhappy. For some reason removing the indentation via suggestions removes the blank line. Do you mind making the modification on your local repository?
You can then check the lint with

$ flake8 sklearn/utils/__init__.py

Also, do you mind adding dashes under the "See Also" title until the end of the title as in this example?
Thank you very much.

rth · Mar 17, 2021

I pushed the fix. It's indeed some issue with GH suggestions.

seanbenhur · Mar 17, 2021

Thanks for your suggestions and help @cmarmo , I guess the issue was resolved!, From next time I will folliw these best practices!

jeremiedbb

Thanks @seanbenhur and @cmarmo !

seanbenhur added 2 commits March 16, 2021 12:55

Update classes.rst

130c56d

Merge pull request #1 from seanbenhur/seanbenhur-patch-1

da50230

Added utils.gen_batches in documentation, Solving issue #19681

cmarmo added Documentation module:utils labels Mar 16, 2021

cmarmo approved these changes Mar 16, 2021

View reviewed changes

rth approved these changes Mar 16, 2021

View reviewed changes

Cross link gen_batches and gen_even_slices in See Also section

dcb3701

cmarmo reviewed Mar 16, 2021

View reviewed changes

sklearn/utils/__init__.py Outdated Show resolved Hide resolved

sklearn/utils/__init__.py Outdated Show resolved Hide resolved

seanbenhur and others added 3 commits March 17, 2021 09:01

Add linting

be2bc68

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

Update sklearn/utils/__init__.py

f9f2cb6

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

Add linting

d3ba97c

Removes a boank line

62378aa

cmarmo reviewed Mar 17, 2021

View reviewed changes

sklearn/utils/__init__.py Outdated Show resolved Hide resolved

sklearn/utils/__init__.py Outdated Show resolved Hide resolved

seanbenhur and others added 2 commits March 17, 2021 15:30

Update sklearn/utils/__init__.py

3b0cdb2

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

Fix linting

85adffd

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

cmarmo reviewed Mar 17, 2021

View reviewed changes

sklearn/utils/__init__.py Outdated Show resolved Hide resolved

cmarmo reviewed Mar 17, 2021

View reviewed changes

sklearn/utils/__init__.py Outdated Show resolved Hide resolved

Fix Linting

e428db4

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

seanbenhur and others added 3 commits March 17, 2021 15:45

Update __init__.py

11d0da6

Merge pull request #2 from seanbenhur/seanbenhur-patch-2

e86688d

Fix linting

Fix Linting

17c6110

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

Add gen_batches in utils doc

ff44077

cmarmo reviewed Mar 17, 2021

View reviewed changes

sklearn/utils/__init__.py Outdated Show resolved Hide resolved

Update sklearn/utils/__init__.py

6c3d811

Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>

Add a blink line

b9cb835

jeremiedbb reviewed Mar 17, 2021

View reviewed changes

sklearn/utils/__init__.py Outdated Show resolved Hide resolved

sklearn/utils/__init__.py Outdated Show resolved Hide resolved

seanbenhur and others added 2 commits March 17, 2021 18:28

Update sklearn/utils/__init__.py

c40c3a9

Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>

Update sklearn/utils/__init__.py

bcd1973

Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>

Fix lint

a9c7906

Fix section underline

df6eb6b

jeremiedbb approved these changes Mar 17, 2021

View reviewed changes

jeremiedbb merged commit 04f84c6 into scikit-learn:main Mar 17, 2021

glemaitre mentioned this pull request Apr 22, 2021

Release 0.24.2 #19954

Merged

12 tasks

glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Apr 22, 2021

DOC Added utils.gen_batches in documentation (scikit-learn#19688)

18975c3

glemaitre pushed a commit that referenced this pull request Apr 28, 2021

DOC Added utils.gen_batches in documentation (#19688)

80b0857

Search code, repositories, users, issues, pull requests...

Uh oh!

Added utils.gen_batches in documentation, Solving issue #19681 #19688

Added utils.gen_batches in documentation, Solving issue #19681 #19688

Uh oh!

Conversation

seanbenhur commented Mar 16, 2021 • edited by rth Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What does this implement/fix? Explain your changes.

Any other comments?

Uh oh!

cmarmo left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

seanbenhur commented Mar 16, 2021

Uh oh!

rth left a comment

Choose a reason for hiding this comment

Uh oh!

rth commented Mar 16, 2021

Uh oh!

seanbenhur commented Mar 16, 2021

Uh oh!

cmarmo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

seanbenhur commented Mar 17, 2021

Uh oh!

cmarmo commented Mar 17, 2021

Uh oh!

seanbenhur commented Mar 17, 2021

Uh oh!

cmarmo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cmarmo commented Mar 17, 2021

Uh oh!

Uh oh!

seanbenhur commented Mar 17, 2021 via email

Uh oh!

Uh oh!

cmarmo commented Mar 17, 2021

Uh oh!

Uh oh!

cmarmo commented Mar 17, 2021

Uh oh!

cmarmo commented Mar 17, 2021

Uh oh!

seanbenhur commented Mar 17, 2021

Uh oh!

jeremiedbb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

cmarmo commented Mar 17, 2021

Uh oh!

rth commented Mar 17, 2021

Uh oh!

seanbenhur commented Mar 17, 2021

Uh oh!

jeremiedbb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

seanbenhur commented Mar 16, 2021 •

edited by rth

Loading

cmarmo left a comment •

edited

Loading