-
Notifications
You must be signed in to change notification settings - Fork 57
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
Update Docstrings in all classes related to RandomVariables #213
Update Docstrings in all classes related to RandomVariables #213
Conversation
Codecov Report
@@ Coverage Diff @@
## master #213 +/- ##
==========================================
+ Coverage 74.40% 74.88% +0.48%
==========================================
Files 60 60
Lines 3169 3158 -11
Branches 414 410 -4
==========================================
+ Hits 2358 2365 +7
+ Misses 647 624 -23
- Partials 164 169 +5
Continue to review full report at Codecov.
|
…to docstring-updates
… into docstring-updates
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a comment every time something didn't read smoothly, so my comments are relatively noisy. Not everything needs fixing.
This PR updates and adds missing docstrings to the recently refactored classes associated with
RandomVariable
.Docstrings
RandomVariable
(closes Write a warning into RandomVariable about order of operations #146)Tutorials and Quickstart Guide:
Developer Guides:
[ ] describe the steps to add a newRandomVariable
subclass, including how to define new arithmetic operationsOther:
__repr__
of RandomVariables (see also Documentation of changes inRandomVariable
#199 (comment))This PR closes #199.
Note: You can view the built documentation by going to the "Details" page of the
docs/readthedocs.org:probnum
check, which builds a version of the documentation corresponding to this PR.