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

Fix formatting in documentation of AR distribution parameters #6080

Merged
merged 2 commits into from
Sep 4, 2022

Conversation

daniel-saunders-phil
Copy link
Contributor

@daniel-saunders-phil daniel-saunders-phil commented Aug 29, 2022

What is this PR about?

Fixed a variety of docstring issues for the pm.AR distribution.

...

Checklist

Major / Breaking Changes

  • ...

Bugfixes / New features

  • ...

Docs / Maintenance

  • Fix formatting in documentation of AR distribution parameters

@codecov
Copy link

codecov bot commented Aug 29, 2022

Codecov Report

Merging #6080 (0683b0a) into main (c8ce9c9) will increase coverage by 4.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #6080      +/-   ##
==========================================
+ Coverage   85.52%   89.53%   +4.01%     
==========================================
  Files          72       72              
  Lines       12933    12933              
==========================================
+ Hits        11061    11580     +519     
+ Misses       1872     1353     -519     
Impacted Files Coverage Δ
pymc/distributions/timeseries.py 77.99% <ø> (+34.62%) ⬆️
pymc/distributions/continuous.py 97.51% <0.00%> (+0.10%) ⬆️
pymc/sampling.py 82.15% <0.00%> (+0.11%) ⬆️
pymc/printing.py 86.66% <0.00%> (+0.95%) ⬆️
pymc/distributions/multivariate.py 92.03% <0.00%> (+0.98%) ⬆️
pymc/distributions/discrete.py 99.21% <0.00%> (+1.56%) ⬆️
pymc/util.py 77.64% <0.00%> (+2.35%) ⬆️
pymc/backends/arviz.py 90.61% <0.00%> (+4.48%) ⬆️
pymc/step_methods/hmc/quadpotential.py 80.69% <0.00%> (+6.93%) ⬆️
pymc/data.py 80.08% <0.00%> (+12.19%) ⬆️
... and 4 more

@reshamas
Copy link
Contributor

reshamas commented Sep 2, 2022

#DataUmbrellaPyMCSprint

@cluhmann
Copy link
Member

cluhmann commented Sep 2, 2022

This looks good to me. The only question I would have is about the "unnamed distribution" which seems correct, but there may be some other "docstring-official" way of specifying this. Not sure.

@cluhmann
Copy link
Member

cluhmann commented Sep 2, 2022

And thank you for your contribution @daniel-saunders-phil !

@ricardoV94
Copy link
Member

This looks good to me. The only question I would have is about the "unnamed distribution" which seems correct, but there may be some other "docstring-official" way of specifying this. Not sure.

We should make one like tensor_like, but there isn't any right now. Do you want to open an issue to track that?

@OriolAbril
Copy link
Member

"unnamed distribution" should be Distribution which for now points to the API section with all distributions, we could update it at any point to be a glossary term. The fact it is unnamed is not related to the type but to a property some objects with this type have and that info should be described at the parameter description section (which is already done, so no changes needed here).

@cluhmann
Copy link
Member

cluhmann commented Sep 2, 2022

Yeah, I think a glossary term would be good, because I suspect that stating that this argument should be a "Distribution" is going to cause some confusion. Chime in here.

@ricardoV94 ricardoV94 changed the title Docstring ar Fix formatting in documentation of AR distribution parameters Sep 4, 2022
@ricardoV94 ricardoV94 merged commit 23df308 into pymc-devs:main Sep 4, 2022
@daniel-saunders-phil daniel-saunders-phil deleted the docstring_AR branch August 9, 2023 22:30
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.

6 participants