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

Updated pymc.Normal docstring #5487

Merged
merged 4 commits into from
Feb 19, 2022
Merged

Conversation

sagartomar
Copy link
Contributor

@sagartomar sagartomar commented Feb 18, 2022

Thank your for opening a PR!

Depending on what your PR does, here are a few things you might want to address in the description:

For issue #5459

#DataUmbrellaPyMCSprint

pymc/distributions/continuous.py Outdated Show resolved Hide resolved
pymc/distributions/continuous.py Outdated Show resolved Hide resolved
pymc/distributions/continuous.py Outdated Show resolved Hide resolved
pymc/distributions/continuous.py Outdated Show resolved Hide resolved
@codecov
Copy link

codecov bot commented Feb 18, 2022

Codecov Report

Merging #5487 (fedd5c5) into main (2b81f4e) will decrease coverage by 15.57%.
The diff coverage is n/a.

❗ Current head fedd5c5 differs from pull request most recent head 29240c2. Consider uploading reports for the commit 29240c2 to get more accurate results

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #5487       +/-   ##
===========================================
- Coverage   81.47%   65.89%   -15.58%     
===========================================
  Files          81       81               
  Lines       14204    14204               
===========================================
- Hits        11572     9360     -2212     
- Misses       2632     4844     +2212     
Impacted Files Coverage Δ
pymc/distributions/continuous.py 61.06% <ø> (-36.17%) ⬇️
pymc/step_methods/mlda.py 12.46% <0.00%> (-83.94%) ⬇️
pymc/ode/utils.py 17.85% <0.00%> (-82.15%) ⬇️
pymc/func_utils.py 22.50% <0.00%> (-65.00%) ⬇️
pymc/printing.py 22.22% <0.00%> (-63.64%) ⬇️
pymc/ode/ode.py 24.24% <0.00%> (-60.61%) ⬇️
pymc/step_methods/hmc/hmc.py 33.96% <0.00%> (-58.50%) ⬇️
pymc/distributions/censored.py 37.28% <0.00%> (-55.94%) ⬇️
pymc/distributions/bound.py 44.32% <0.00%> (-55.68%) ⬇️
pymc/distributions/discrete.py 52.01% <0.00%> (-47.75%) ⬇️
... and 24 more

Precision (tau > 0) (only required if sigma is not specified).
Defaults to 1 if neither sigma nor tau is specified.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Defaults to 1 if neither sigma nor tau is specified.

only one of tau or sigma are used, I think it's better to leave the explanation as no value for tau or sigma -> sigma=1 (tau=1 is equivalent to sigma=1 but that might still be confusing for many pymc users)

@OriolAbril OriolAbril merged commit deefd7e into pymc-devs:main Feb 19, 2022
@sagartomar sagartomar deleted the docstring_update branch March 11, 2022 08:35
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.

4 participants