Skip to content

DOC ensures that paired_distances passes numpydoc validation.#21440

Closed
isaacknjama wants to merge 1 commit intoscikit-learn:mainfrom
isaacknjama:paired_distances
Closed

DOC ensures that paired_distances passes numpydoc validation.#21440
isaacknjama wants to merge 1 commit intoscikit-learn:mainfrom
isaacknjama:paired_distances

Conversation

@isaacknjama
Copy link
Copy Markdown
Contributor

@isaacknjama isaacknjama commented Oct 24, 2021

Addressed #21350

#dataumbrella

@isaacknjama isaacknjama changed the title Removed from ignore list DOC ensures that paired_distances passes numpydoc validation. Oct 24, 2021
@glemaitre glemaitre changed the title DOC ensures that paired_distances passes numpydoc validation. [WIP] DOC ensures that paired_distances passes numpydoc validation. Oct 24, 2021
@glemaitre glemaitre changed the title [WIP] DOC ensures that paired_distances passes numpydoc validation. DOC ensures that paired_distances passes numpydoc validation. Oct 24, 2021
@glemaitre glemaitre marked this pull request as draft October 24, 2021 09:11
@glemaitre
Copy link
Copy Markdown
Member

I converted this PR into a draft PR to avoid reviewers coming around until you edit the paired_distances docstring.
Once you do the change, you can click on "Ready for review" above.

@isaacknjama
Copy link
Copy Markdown
Contributor Author

I converted this PR into a draft PR to avoid reviewers coming around until you edit the paired_distances docstring. Once you do the change, you can click on "Ready for review" above.

Got it!

@reshamas
Copy link
Copy Markdown
Member

reshamas commented Nov 5, 2021

Hello @isaack-mungui How is this PR going? Do you need assistance?

@isaacknjama
Copy link
Copy Markdown
Contributor Author

Hello @isaack-mungui How is this PR going? Do you need assistance?

Hello @reshamas I've had my hands full but plan on finalizing the PR by end of week. Will reach out in case I need assistance.

@reshamas
Copy link
Copy Markdown
Member

Hi @isaack-mungui
I am looking at this pull request and it looks like you removed the function "sklearn.metrics.pairwise.paired_distances", but haven't yet made any changes to the file to the associated pairwise.py file.

E           # Errors
E           
E            - SS05: Summary must start with infinitive verb, not third person (e.g. use "Generate" instead of "Generates")
E            - PR01: Parameters {'**kwds'} not documented
E            - RT03: Return value has no description

Let me know if I can help on this PR.

@isaacknjama
Copy link
Copy Markdown
Contributor Author

Hi @reshamas. I'd appreciate your help on this PR.

@reshamas
Copy link
Copy Markdown
Member

reshamas commented Dec 2, 2021

@isaack-mungui Can you make it to the next office hours for scikit-learn? Info is below.


Hi all,

Some of us will be online on the scikit-learn discord Monday December 6 at
10:00 PT / 13:00 ET / 18:00 UTC / 19:00 CET for about an hour or so.

First time and occasional contributors are welcome to join us to
discord using this invitation link:
https://discord.gg/YyYRXMju https://discord.gg/YyYRXMju

The focus of these office hour sessions is to answer questions about
contributing to scikit-learn. We can also split into break out
audio/text channels and do pair programming or live reviewing of
forgotten pull requests with screen sharing.

We can also try to assist you into crafting minimal reproduction cases
for bug reports to get a higher likelihood of resolution (e.g.
https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports).

Please note, our Code of Conduct applies:
https://github.com/scikit-learn/scikit-learn/blob/main/CODE_OF_CONDUCT.md https://github.com/scikit-learn/scikit-learn/blob/main/CODE_OF_CONDUCT.md

@isaacknjama
Copy link
Copy Markdown
Contributor Author

@isaack-mungui Can you make it to the next office hours for scikit-learn? Info is below.

Hi all,

Some of us will be online on the scikit-learn discord Monday December 6 at 10:00 PT / 13:00 ET / 18:00 UTC / 19:00 CET for about an hour or so.

First time and occasional contributors are welcome to join us to discord using this invitation link: https://discord.gg/YyYRXMju https://discord.gg/YyYRXMju

The focus of these office hour sessions is to answer questions about contributing to scikit-learn. We can also split into break out audio/text channels and do pair programming or live reviewing of forgotten pull requests with screen sharing.

We can also try to assist you into crafting minimal reproduction cases for bug reports to get a higher likelihood of resolution (e.g. https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports https://matthewrocklin.com/blog/work/2018/02/28/minimal-bug-reports).

Please note, our Code of Conduct applies: https://github.com/scikit-learn/scikit-learn/blob/main/CODE_OF_CONDUCT.md https://github.com/scikit-learn/scikit-learn/blob/main/CODE_OF_CONDUCT.md

@reshamas I won't make it to the office hours. currently have exams.

@reshamas
Copy link
Copy Markdown
Member

@glemaitre
Either @genvalen or I can complete this PR.
It's been open since Oct 2021.

@glemaitre
Copy link
Copy Markdown
Member

Yes, feel free to take over and you can request a review from me on the new PR.

@genvalen
Copy link
Copy Markdown
Contributor

Hi @reshamas, please go ahead! I have my hands full for a little bit.

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.

4 participants