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 use the arxiv directive in the docstrings #21418

Merged
merged 91 commits into from
Jan 28, 2022

Conversation

SultanOrazbayev
Copy link
Contributor

@SultanOrazbayev SultanOrazbayev commented Oct 23, 2021

Reference Issues/PRs

References #21088

  • update :arxiv:

What does this implement/fix? Explain your changes.

Update docstrings to use consistent naming of :arxiv: links.

Any other comments?

Together with @aufarkari we updated the :arxiv: links only (so :doi: still need to be updated in a separate PR).

@SultanOrazbayev SultanOrazbayev changed the title [WIP] Arxiv updating [MRG] Arxiv updating Oct 23, 2021
Copy link
Member

@ogrisel ogrisel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you address all the remaining arxiv links in one single PR?

If not please put the names of the code / doc modules in the title of the PR so that others can see more specifically what this PR is about.

doc/datasets/loading_other_datasets.rst Outdated Show resolved Hide resolved
@cmarmo
Copy link
Member

cmarmo commented Oct 26, 2021

Thanks @SultanOrazbayev the lint check is failing with the following error

sklearn/linear_model/_sag.py:233:1: W293 blank line contains whitespace

Do you mind fixing the check? Thanks!
You can find more details about the lint check on this page.

blank line contains whitespace
@SultanOrazbayev
Copy link
Contributor Author

Thanks @SultanOrazbayev the lint check is failing with the following error

sklearn/linear_model/_sag.py:233:1: W293 blank line contains whitespace

Do you mind fixing the check? Thanks! You can find more details about the lint check on this page.

Sorry about this, I was using the web editor, so this slipped through.

Copy link
Member

@cmarmo cmarmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @aufarkari , thanks for your follow-up. You need to fix conflicts before adding new modifications. You might want to have a look to the github documentation for this.

sklearn/cluster/_hierarchical_fast.pyx Outdated Show resolved Hide resolved
sklearn/ensemble/_hist_gradient_boosting/splitting.pyx Outdated Show resolved Hide resolved
@aufarkari
Copy link
Contributor

aufarkari commented Dec 20, 2021 via email

Copy link
Member

@cmarmo cmarmo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You still have some lint errors:

sklearn/neural_network/_multilayer_perceptron.py:1024:70: W291 trailing whitespace
sklearn/neural_network/_multilayer_perceptron.py:1492:89: E501 line too long (92 > 88 characters)
sklearn/neural_network/_multilayer_perceptron.py:1495:70: W291 trailing whitespace
sklearn/neural_network/_stochastic_optimizers.py:240:89: E501 line too long (108 > 88 characters)

They prevent the build of the documentation making more difficult the review.

sklearn/neural_network/_multilayer_perceptron.py Outdated Show resolved Hide resolved
@cmarmo
Copy link
Member

cmarmo commented Dec 30, 2021

Hi @aufarkari , thanks for following up. Some conflicts arose, a synchronization with upstream main is needed to allow all the checks to run.

@glemaitre glemaitre self-requested a review January 28, 2022 14:45
@glemaitre glemaitre changed the title [MRG] Arxiv updating MAINT use the arxiv directive in the docstring Jan 28, 2022
@glemaitre glemaitre changed the title MAINT use the arxiv directive in the docstring MAINT use the arxiv directive in the docstrings Jan 28, 2022
@glemaitre glemaitre changed the title MAINT use the arxiv directive in the docstrings DOC use the arxiv directive in the docstrings Jan 28, 2022
Copy link
Member

@jjerphan jjerphan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM given that the CI passes.

@glemaitre glemaitre merged commit cd892f9 into scikit-learn:main Jan 28, 2022
@glemaitre
Copy link
Member

Thanks @SultanOrazbayev All is good with the CIs. Let's merge.

@SultanOrazbayev
Copy link
Contributor Author

Thank you very much! This was a joint effort with @aufarkari. Great to make a small contribution to scikit-learn!

@glemaitre
Copy link
Member

Nice work to both you then :)

mathijs02 pushed a commit to mathijs02/scikit-learn that referenced this pull request Dec 27, 2022
Co-authored-by: aufarkari <aufar.di.sini@gmail.com>
Co-authored-by: Chiara Marmo <cmarmo@users.noreply.github.com>
Co-authored-by: Julien Jerphanion <git@jjerphan.xyz>
Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
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

8 participants