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

Correct docs for Bernoulli, Poisson, Negative Binomial, Geometric and HyperGeometric #5958

Merged
merged 2 commits into from
Jul 13, 2022
Merged

Correct docs for Bernoulli, Poisson, Negative Binomial, Geometric and HyperGeometric #5958

merged 2 commits into from
Jul 13, 2022

Conversation

SangamSwadiK
Copy link
Contributor

What is this PR about?
Issue: #5459
This PR corrects docs for Bernoulli, Poisson, Negative Binomial, Geometric and missing plot context in HyperGeometric for numpydoc compliance.

Checklist

Major / Breaking Changes

None

Bugfixes / New features

None

Docs / Maintenance

Corrects docs of the mentioned discrete distributions for numpydoc compliance.
#DataUmbrellaPyMCSprint2022 @reshamas

@codecov
Copy link

codecov bot commented Jul 8, 2022

Codecov Report

Merging #5958 (72d5bea) into main (966aabf) will increase coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #5958   +/-   ##
=======================================
  Coverage   89.41%   89.42%           
=======================================
  Files          73       73           
  Lines       13292    13292           
=======================================
+ Hits        11885    11886    +1     
+ Misses       1407     1406    -1     
Impacted Files Coverage Δ
pymc/distributions/discrete.py 99.21% <ø> (ø)
pymc/step_methods/hmc/base_hmc.py 90.55% <0.00%> (+0.78%) ⬆️

Copy link
Member

@michaelosthege michaelosthege left a comment

Choose a reason for hiding this comment

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

@OriolAbril can you review here? I think there need to be additional spaces left of the :?

For example mu : tensor_like of float instead of mu: tensor_like of float

@SangamSwadiK
Copy link
Contributor Author

@OriolAbril can you review here? I think there need to be additional spaces left of the :?

For example mu : tensor_like of float instead of mu: tensor_like of float

Hi, I looked into the guide on dataumbrella
and updated with correct spacing before and after colon.

@cluhmann
Copy link
Member

cluhmann commented Jul 9, 2022

You might want to include :context: close-figs just after the .. plot:: as detailed in the tutorial. Otherwise, it looks good to me.

@twiecki
Copy link
Member

twiecki commented Jul 13, 2022

Ping @SangamSwadiK , do you know what needs to be done here?

@SangamSwadiK
Copy link
Contributor Author

Ping @SangamSwadiK , do you know what needs to be done here?

@cluhmann @twiecki
Hi, sorry for the late reply, was in middle of heavy monsoon and a storm.

I've gone through the tutorial and have already added the :context: close-figs in the previous PR, and I've checked again. I may be missing something, please let me know if I missed something.

Thanks for helping !!

@twiecki twiecki merged commit a9baa42 into pymc-devs:main Jul 13, 2022
@twiecki
Copy link
Member

twiecki commented Jul 13, 2022

Thanks @SangamSwadiK!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants