added descriptions to all distribution input specs #2341
Conversation
|
Job Test Ubuntu 18-2 Python 3 on dcc932c : invalidated by @GabrielSoto-INL |
|
Job Mingw Test on dcc932c : invalidated by @GabrielSoto-INL |
ravenframework/Distributions.py
Outdated
| See \url{https://docs.scipy.org/doc/scipy/reference/generated/scipy.stats.triang.html} for more details. | ||
| """ | ||
| inputSpecification.addSub(InputData.parameterInputFactory("min", | ||
| descr=r"""lower domain boundary of this distribution, referred to as $a$ in euqation form.""", |
There was a problem hiding this comment.
small typo in descr here, same in line 1206 for the max parameter
ravenframework/Distributions.py
Outdated
| @@ -1433,7 +1537,14 @@ class cls. | |||
| specifying input of cls. | |||
| """ | |||
| inputSpecification = super(Bernoulli, cls).getInputSpecification() | |||
| inputSpecification.addSub(InputData.parameterInputFactory("p", contentType=InputTypes.FloatType)) | |||
| inputSpecification.description = r"""classical Bournoulli discrete distribution. The probability mass function for the | |||
There was a problem hiding this comment.
small typo for the distribution name here
ravenframework/Distributions.py
Outdated
|
|
||
| DataFilenameParameterInput = InputData.parameterInputFactory("dataFilename", contentType=InputTypes.StringType) | ||
| DataFilenameParameterInput.addParam("type", InputTypes.StringType, True) | ||
| inputSpecification.description = r"""Custom user-defined N-diminsional distribution. This allows empirically-defined |
There was a problem hiding this comment.
small typo in N-dimensional
ravenframework/Distributions.py
Outdated
| TransformationParameterInput = InputData.parameterInputFactory("transformation") | ||
| RankParameterInput = InputData.parameterInputFactory("rank", contentType=InputTypes.IntegerType) | ||
| inputSpecification.description = r"""describes a N-dimensional multivariate Gaussian normal distribution. | ||
| This generalizes the univariate nurmal distribution to higher dimensions. The multivariate normal |
There was a problem hiding this comment.
small typo in "univariate normal distribution"
There was a problem hiding this comment.
it becomes clear to me that I rely a lot on spellcheckers flagging my mistakes in text! However, for visibility reasons I disabled it for code. Do you know a way to convince it only to spellcheck within text by chance?
Thanks for finding all of these.
There was a problem hiding this comment.
I don't know of any really smart ones that can identify when you're formatting strings or something like that, unfortunately. I think the "Code Spell Checker" extension in VS Code looks pretty good, but could see it getting annoying, like you mentioned.
Pull Request Description
What issue does this change request address? (Use "#" before the issue to link it, i.e., #42.)
idaholab/HERON#372
What are the significant changes in functionality due to this change request?
Adds the input spec descriptions to all the
Distributionobjects in RAVEN, for use in dynamic manual compiling, particularly in HERON.For Change Control Board: Change Request Review
The following review must be completed by an authorized member of the Change Control Board.
<internalParallel>to True.raven/tests/framework/user_guideandraven/docs/workshop) have been changed, the associated documentation must be reviewed and assured the text matches the example.