Skip to content

Fix typos in PolyaGamma's docstring #6672

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

Merged
merged 2 commits into from
Jun 14, 2023
Merged

Conversation

aleicazatti
Copy link
Contributor

@aleicazatti aleicazatti commented Apr 13, 2023

Fix typos and change a detail in PolyaGamma's docstring.

  • A backslash and a backtick were missing in the math code block for the mean and the deployment looked like this:
    Captura desde 2023-04-13 20-03-09

  • The example plot wasn't deployed and it was the only distribution with plt.style.use('seaborn-darkgrid'). This commit imports arviz and uses plt.style.use('arviz-darkgrid') instead.

...

Checklist


📚 Documentation preview 📚: https://pymc--6672.org.readthedocs.build/en/6672/

@codecov
Copy link

codecov bot commented Apr 13, 2023

Codecov Report

Merging #6672 (4d18474) into main (fa82fef) will increase coverage by 2.49%.
The diff coverage is 100.00%.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #6672      +/-   ##
==========================================
+ Coverage   89.50%   91.99%   +2.49%     
==========================================
  Files          94       95       +1     
  Lines       15942    16180     +238     
==========================================
+ Hits        14269    14885     +616     
+ Misses       1673     1295     -378     
Impacted Files Coverage Δ
pymc/distributions/continuous.py 97.74% <ø> (+0.03%) ⬆️
pymc/logprob/basic.py 99.15% <100.00%> (ø)

... and 18 files with indirect coverage changes

@ricardoV94
Copy link
Member

@OriolAbril
Copy link
Member

The rtd log has ModuleNotFoundError: No module named 'polyagamma'. The code snippet uses the polyagamma library but I guess it is not part of the docs conda env, so it can't actually generate the plot

@ricardoV94
Copy link
Member

The rtd log has ModuleNotFoundError: No module named 'polyagamma'. The code snippet uses the polyagamma library but I guess it is not part of the docs conda env, so it can't actually generate the plot

Right, it's an optional dependency. Shall we merge as is, or is it a problem?

@OriolAbril
Copy link
Member

I wouldn't merge as is. Either add the dependency to the doc build env, or remove the code to generate the plot (the code isn't shown, so the only value of it being in the docstring is the plot it generates)

@OriolAbril OriolAbril merged commit 9d24a78 into pymc-devs:main Jun 14, 2023
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