-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/pre-commit run |
Codecov Report
@@ 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
|
/pre-commit-run |
Needs that extra dash 💨 |
OriolAbril
changed the title
Updated pymc.Uniform docstring
Several API doc improvements
Jan 18, 2022
twiecki
reviewed
Jan 21, 2022
OriolAbril
commented
Jan 21, 2022
twiecki
approved these changes
Jan 21, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
__init__
to the class docstring (which effective added the docstring of the base distribution init to every single distribution).pymc.gp
for implementations, pymc.gp.mean for means and pymc.gp.cov for covariance. Moreover. I added aliases so that usingMean
andCovariance
in type descriptions generates links to the respective module (this is not working yet because the docstrings don't follow numpydoc yet)