Documentation update in stats/joint_rv_types.py #18589
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
|
✅ Hi, I am the SymPy bot (v149). I'm here to help you write a release notes entry. Please read the guide on how to write release notes. Your release notes are in good order. Here is what the release notes will look like:
This will be added to https://github.com/sympy/sympy/wiki/Release-Notes-for-1.6. Note: This comment will be updated with the latest check if you edit the pull request. You need to reload the page to see it. Click here to see the pull request description that was parsed.
Update The release notes on the wiki have been updated. |
Codecov Report
@@ Coverage Diff @@
## master #18589 +/- ##
=============================================
+ Coverage 75.323% 75.561% +0.238%
=============================================
Files 640 644 +4
Lines 167176 167515 +339
Branches 39427 39485 +58
=============================================
+ Hits 125922 126577 +655
+ Misses 35721 35413 -308
+ Partials 5533 5525 -8 |
|
There seem to be unrelated changes in this PR. |
|
I will fix this right away |
Corrected and modified some documentation. Added doctests.
NormalGamma uses variable and parameter syms while it actually accepts only a single symbol. So, in that function, syms was changed to sym.
mijo2
force-pushed
the
15063_stats_doc
branch
from
b2b0067
to
52484d0
Compare
The build failed due to connection error issues so in this commit minor change was made for the build to start again.
czgdp1807
reviewed
Feb 10, 2020
sympy/stats/joint_rv_types.py
Outdated
| syms: list/tuple/set of symbols for identifying each component | ||
| mu: A list/tuple/set consisting of k means,represents a k | ||
| dimensional location vector | ||
| syms: A symbol/str for identifying the random variable. |
There was a problem hiding this comment.
syms: A symbol/str
For identifying the random variable
There was a problem hiding this comment.
@czgdp1807 I will make the necessary changes
A newline between the description and the type of the parameter
czgdp1807
reviewed
Feb 10, 2020
sympy/stats/joint_rv_types.py
Outdated
| dimensional location vector | ||
| syms: A symbol/str | ||
| For identifying the random variable. | ||
| mu: A list/matrix representing the location vector |
Docstring for some functions was updated to have one newline
|
LGTM. |
Smit-create
reviewed
Feb 11, 2020
Smit-create
reviewed
Feb 11, 2020
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.
References to other Issues or PRs
Revives #15063
Closes #15063
Closes #18557
Brief description of what is fixed or changed
--> Updated the documentation in two functions, NormalGamma and JointRV in stats/joint_rv_types.py
Other comments
Release Notes