Skip to content

DOC Ensures that check_pairwise_arrays passes numpydoc validation#23519

Merged
jeremiedbb merged 6 commits intoscikit-learn:mainfrom
wchathura:fix_docs
Jun 2, 2022
Merged

DOC Ensures that check_pairwise_arrays passes numpydoc validation#23519
jeremiedbb merged 6 commits intoscikit-learn:mainfrom
wchathura:fix_docs

Conversation

@wchathura
Copy link
Copy Markdown
Contributor

@wchathura wchathura commented Jun 2, 2022

Reference Issues/PRs

Addresses #21350

What does this implement/fix? Explain your changes.

Fixes the function check_pairwise_arrays function to pass numpydoc validation

Any other comments?

This is my first contribution. Any advice is appreciated

jeremiedbb
jeremiedbb reviewed Jun 2, 2022
View reviewed changes
Copy link
Copy Markdown
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 for the PR @wchathura. Here are some suggestions

wchathura and others added 3 commits June 2, 2022 08:46
@wchathura @jeremiedbb
Update sklearn/metrics/pairwise.py
72f3ea7 
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
@wchathura @jeremiedbb
Update sklearn/metrics/pairwise.py
1fbc3f3 
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
@wchathura @jeremiedbb
Update sklearn/metrics/pairwise.py
2c5a3c1 
Co-authored-by: Jérémie du Boisberranger <34657725+jeremiedbb@users.noreply.github.com>
@wchathura
Copy link
Copy Markdown
Contributor Author

wchathura commented Jun 2, 2022

I committed the suggestions using "commit suggestions" button. How can I further proceed? Thank you very much!!

@jeremiedbb
Copy link
Copy Markdown
Member

jeremiedbb commented Jun 2, 2022

I just noticed that you also modified pairwise_kernels. Can you remove it from the list as well to check that it now passes numpydoc validation ?

@wchathura
Copy link
Copy Markdown
Contributor Author

wchathura commented Jun 2, 2022

Hi I removed the "pairwise_kernels" from the list and ran the test. Test passed. Here is the code I used to run the test
pytest sklearn/tests/test_docstrings.py -k sklearn.metrics.pairwise.pairwise_kernels

Thank you very much

@jeremiedbb
Copy link
Copy Markdown
Member

jeremiedbb commented Jun 2, 2022

Hi I removed the "pairwise_kernels" from the list and ran the test.

thanks but I meant removing it in the PR :) don't worry I just did it

@wchathura
Copy link
Copy Markdown
Contributor Author

wchathura commented Jun 2, 2022

Thank you so much for the help :) :)

jeremiedbb
jeremiedbb approved these changes Jun 2, 2022
View reviewed changes
Copy link
Copy Markdown
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.

LGTM. Thanks @wchathura

@jeremiedbb jeremiedbb merged commit d3b740a into scikit-learn:main Jun 2, 2022
@wchathura
Copy link
Copy Markdown
Contributor Author

wchathura commented Jun 2, 2022

Thank you @jeremiedbb :) Hopefully I can contribute more in the future 🤞

@thomasjpfan thomasjpfan mentioned this pull request Jun 9, 2022
Closed
ogrisel pushed a commit to ogrisel/scikit-learn that referenced this pull request Jul 11, 2022
@wchathura @ogrisel
DOC Ensures that check_pairwise_arrays and pairwise_kernel pass numpy…
a652f06 
…doc validation (scikit-learn#23519)
glemaitre pushed a commit to glemaitre/scikit-learn that referenced this pull request Aug 4, 2022
@wchathura @glemaitre
DOC Ensures that check_pairwise_arrays and pairwise_kernel pass numpy…
e8bbc3a 
…doc validation (scikit-learn#23519)
glemaitre pushed a commit that referenced this pull request Aug 5, 2022
@wchathura @glemaitre
DOC Ensures that check_pairwise_arrays and pairwise_kernel pass numpy…
20d17ad 
…doc validation (#23519)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jeremiedbb jeremiedbb jeremiedbb approved these changes

Assignees

No one assigned

Labels

Documentation module:metrics No Changelog Needed

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@wchathura @jeremiedbb