Skip to content

DOC Ensures that make_blobs passes numpydoc validation#22342

Merged
thomasjpfan merged 7 commits intoscikit-learn:mainfrom
Hashcode-Ankit:main
Feb 1, 2022
Merged

DOC Ensures that make_blobs passes numpydoc validation#22342
thomasjpfan merged 7 commits intoscikit-learn:mainfrom
Hashcode-Ankit:main

Conversation

@Hashcode-Ankit
Copy link
Copy Markdown
Contributor

@Hashcode-Ankit Hashcode-Ankit commented Jan 30, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Fix the description of sklearn.datasets._samples_generator.make_blobs

@thomasjpfan
Copy link
Copy Markdown
Member

thomasjpfan commented Jan 30, 2022

Thanks for the PR!

This PR contains a full virtual environment called sklearn-env with over 3 million lines of code. This folder needs to be removed before we can review the PR.

Removing the folder requires some knowledge to git. So I think it's best to start over following the Contributing guide Specifically item 8 where you create your own feature branch, and item 9 where you only add the file you changed. In this case:

git add sklearn/datasets/_samples_generator.py

@thomasjpfan thomasjpfan mentioned this pull request Jan 30, 2022
Merged
@thomasjpfan
Copy link
Copy Markdown
Member

thomasjpfan commented Jan 31, 2022 •
edited
Loading

The million of files are still there because they were committed before sklearn-env was added to .gitignore . I suggest starting over with a new branch and new PR that is synced with main. We recently merged #22344 so you should not run into this issue the second time around.

@Hashcode-Ankit
Copy link
Copy Markdown
Contributor Author

Hashcode-Ankit commented Jan 31, 2022

sure sir

thomasjpfan
thomasjpfan reviewed Jan 31, 2022
View reviewed changes
.gitignore Outdated
sklearn/utils/_weight_vector.pxd
sklearn/linear_model/_sag_fast.pyx
# virtualenv from advanced installation guide
sklearn-env/ No newline at end of file
Copy link
Copy Markdown
Member

@thomasjpfan thomasjpfan Jan 31, 2022

Choose a reason for hiding this comment

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

This is not required anymore as long as you sync with main. We added this to the .gitignore file in another PR. Here is how you sync with upstream:

Assuming you have upstream setup:

git remote add upstream git@github.com:scikit-learn/scikit-learn.git

Sync with upstream

git fetch upstream
git merge upstream/main

Copy link
Copy Markdown
Contributor Author

@Hashcode-Ankit Hashcode-Ankit Feb 1, 2022

Choose a reason for hiding this comment

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

done sir

thomasjpfan
thomasjpfan approved these changes Feb 1, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@thomasjpfan thomasjpfan left a comment

Choose a reason for hiding this comment

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

Thank you for the update @AnkitKumar2698 ! LGTM

@thomasjpfan thomasjpfan changed the title DOC Ensures that sklearn.datasets._samples_generator.make_blobs passes numpydoc validation DOC Ensures that make_blobs passes numpydoc validation Feb 1, 2022
@thomasjpfan thomasjpfan merged commit 7861a4c into scikit-learn:main Feb 1, 2022
@Hashcode-Ankit
Copy link
Copy Markdown
Contributor Author

Hashcode-Ankit commented Feb 2, 2022

Thanks for merging sir

@thomasjpfan thomasjpfan mentioned this pull request Feb 4, 2022
Closed
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Feb 9, 2022
@Hashcode-Ankit @glemaitre
DOC Ensures that make_blobs passes numpydoc validation (scikit-learn#…
e154236 
…22342)
@thomasjpfan thomasjpfan mentioned this pull request Feb 9, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@thomasjpfan thomasjpfan thomasjpfan approved these changes

Assignees

No one assigned

Labels

Documentation module:datasets No Changelog Needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Hashcode-Ankit @thomasjpfan