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

Several API doc improvements #5367

Merged
merged 5 commits into from
Jan 21, 2022
Merged

Conversation

OriolAbril
Copy link
Member

@OriolAbril OriolAbril commented Jan 18, 2022

  • Add autogenerated links in type specifications
  • added example link to navbar
  • disabled the autodoc feature that appended the docstring of __init__ to the class docstring (which effective added the docstring of the base distribution init to every single distribution).
  • modified autosummary template to generate files for all methods automatically. But to speed up the build process, loading time and not clutter the sidebar too much, those are not included in the sidebar
  • Updated gp api docs to document objects where we want users to import them from (I think). I used pymc.gp for implementations, pymc.gp.mean for means and pymc.gp.cov for covariance. Moreover. I added aliases so that using Mean and Covariance in type descriptions generates links to the respective module (this is not working yet because the docstrings don't follow numpydoc yet)
  • Update docstring of pymc.Uniform to comply with numpydoc

@OriolAbril
Copy link
Member Author

/pre-commit run

@codecov
Copy link

codecov bot commented Jan 18, 2022

Codecov Report

Merging #5367 (f15bde5) into main (d52655d) will decrease coverage by 17.18%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #5367       +/-   ##
===========================================
- Coverage   80.36%   63.18%   -17.19%     
===========================================
  Files          89      132       +43     
  Lines       14808    26070    +11262     
===========================================
+ Hits        11901    16473     +4572     
- Misses       2907     9597     +6690     
Impacted Files Coverage Δ
pymc/distributions/continuous.py 96.93% <ø> (-0.50%) ⬇️
pymc/tests/sampler_fixtures.py 0.00% <0.00%> (-84.90%) ⬇️
pymc/ode/utils.py 17.85% <0.00%> (-82.15%) ⬇️
pymc/smc/smc.py 17.99% <0.00%> (-79.92%) ⬇️
pymc/bart/pgbart.py 17.85% <0.00%> (-77.39%) ⬇️
pymc/variational/updates.py 11.33% <0.00%> (-76.36%) ⬇️
pymc/bart/utils.py 6.52% <0.00%> (-76.09%) ⬇️
pymc/smc/sample_smc.py 16.77% <0.00%> (-66.45%) ⬇️
pymc/bart/tree.py 37.68% <0.00%> (-62.32%) ⬇️
pymc/ode/ode.py 24.24% <0.00%> (-60.61%) ⬇️
... and 78 more

@canyon289
Copy link
Member

/pre-commit-run

@canyon289
Copy link
Member

/pre-commit-run

Needs that extra dash 💨

@OriolAbril OriolAbril changed the title Updated pymc.Uniform docstring Several API doc improvements Jan 18, 2022
RELEASE-NOTES.md Outdated Show resolved Hide resolved
RELEASE-NOTES.md Outdated Show resolved Hide resolved
@OriolAbril OriolAbril merged commit 7bd8704 into pymc-devs:main Jan 21, 2022
@OriolAbril OriolAbril deleted the docstring_update branch January 21, 2022 09:49
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.

3 participants