8000 DOC use notebook-style for plot_sparse_cov.py by fkaren27 · Pull Request #22807 · scikit-learn/scikit-learn · GitHub
[go: up one dir, main page]

Skip to content

8000 DOC use notebook-style for plot_sparse_cov.py #22807

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

Merged
merged 8 commits into from
Mar 18, 2022

Conversation

fkaren27
Copy link
Contributor

Reference Issues/PRs

#22406

This is a work in progress as part of the #pariswimlds sprint.

@fkaren27 fkaren27 marked this pull request as draft March 12, 2022 20:34
@lesteve
Copy link
Member
lesteve commented Mar 13, 2022

Thanks for your PR, FYI I edited the title of your PR so that it contains the example filename. The reason for this is that we have a script that updates the #22406 automatically and relies on the example filename being in the PR title.

@lesteve lesteve changed the title WIP Improve the plot sparse cov example WIP use notebook-style for plot_sparse_cov.py Mar 13, 2022
@lesteve lesteve added the Quick Review For PRs that are quick to review label Mar 14, 2022
@lesteve lesteve mentioned this pull request Mar 14, 2022
47 tasks
@ogrisel
Copy link
Member
ogrisel commented Mar 14, 2022

@fkaren27 this PR would benefit from being synchronized with a more recent version of main. For instance, assuming that:

  • upstream is your alias for https://github.com/scikit-learn/scikit-learn.git
  • origin is your alias for https://github.com/fkaren27/scikit-learn.git

then you should be able to do:

# update your local main branch with the latest main from upstream 
git checkout main
git pull upstream main  

# synchronize you branch with the latest changes in main
git checkout example-plot-sparse-cov
git merge main  

# update your PR (#22807) on GitHub
git push origin example-plot-sparse-cov  

Comment on lines 57 to 59



Copy link
Member

Choose a reason for hiding this comment

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

Those extra blank lines are not expected and make the linter step fail on the CI

Suggested change

You can make sure that your files are automatically formatted by running black on them:

pip install black==22.1.0
black examples/covariance/plot_sparse_cov.py

Instead of running the second line in the terminal, you can also format the code directly from VS Code using ctrl-shift-p + "Format document...".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you for the tips, I will correct this.

@fkaren27 fkaren27 marked this pull request as ready for review March 14, 2022 15:45
Copy link
Member
@jeremiedbb jeremiedbb left a comment

Choose a reason for hiding this comment

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

Thanks @fkaren27. I think the rendering would be improved if the comments separating sections were titles

lesteve and others added 3 commits March 18, 2022 14:39
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
@lesteve lesteve changed the title WIP use notebook-style for plot_sparse_cov.py DOC use notebook-style for plot_sparse_cov.py Mar 18, 2022
@lesteve lesteve merged commit 2dc35b9 into scikit-learn:main Mar 18, 2022
@lesteve
Copy link
Member
lesteve commented Mar 18, 2022

Merging, thanks a lot!

glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Apr 6, 2022
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
Co-authored-by: Loïc Estève <loic.esteve@ymail.com>
7358
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Quick Review For PRs that are quick to review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants
0