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 Ensures that PoissonRegressor passes numpydoc validation #20386

Merged
merged 7 commits into from
Jul 7, 2021

Conversation

lacouth
Copy link
Contributor

@lacouth lacouth commented Jun 26, 2021

#DataUmbrella sprint

Reference Issues/PRs

Adresses #20308

cc.: @gitdoluquita pair programming partner

Removing PoissonRegressor from DOCSTRING_IGNORE_LIST
Fixing numpydoc errors in PoissonRegressor class, fit method and family property.

Any other comments?

We are not sure if the property is documented in the right way.

Copy link
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

LGTM. Let see if the CIs catch something else.

@glemaitre
Copy link
Member

I made a small change on the property to see if we can write a more condensed way the property.

@lacouth
Copy link
Contributor Author

lacouth commented Jul 3, 2021

Thanks, @glemaitre. Should we change anything else?

@glemaitre glemaitre self-requested a review July 6, 2021 09:10
Copy link
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

I merge main into your branch. If the CIs agree, we will be merging afterwards.

@glemaitre
Copy link
Member

OK so we will omit the type to pass the validation. If the type is a complex type as ndarray with some shape and dtype, we can provide this information with a Returns section. Here, this is a single string. The summary is enough.

@glemaitre glemaitre self-requested a review July 7, 2021 10:11
Copy link
Member

@glemaitre glemaitre left a comment

Choose a reason for hiding this comment

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

I merge main into the branch, it should solve the issue with the doc CI.

@glemaitre glemaitre merged commit 1fa9ce9 into scikit-learn:main Jul 7, 2021
@glemaitre
Copy link
Member

OK so this is good. Thanks @lacouth

thomasjpfan pushed a commit to thomasjpfan/scikit-learn that referenced this pull request Jul 7, 2021
…learn#20386)

Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
samronsin pushed a commit to samronsin/scikit-learn that referenced this pull request Nov 30, 2021
…learn#20386)

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.

2 participants