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.GaussianRandomWalk docstring #5492

Merged
merged 2 commits into from
Feb 20, 2022
Merged

Updated pymc.GaussianRandomWalk docstring #5492

merged 2 commits into from
Feb 20, 2022

Conversation

GallowayJ
Copy link
Contributor

I made the following changes to the docstrings in the GaussianRandomWalk class and its methods:

  • Added spaces preceding colons
  • Changed occurrences of tensor to TensorVariable
  • In class parameters, added optional to type hints
  • Added backticks to mentions of variables in parameter class description

These changes are part of work towards issue #5459.

  • right before it's ready to merge, mention the PR in the RELEASE-NOTES.md

#DataUmbrellaPyMCSprint

@canyon289
Copy link
Member

Thank you for the contribution!

@codecov
Copy link

codecov bot commented Feb 19, 2022

Codecov Report

Merging #5492 (13649d0) into main (af14bea) will increase coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #5492      +/-   ##
==========================================
+ Coverage   81.44%   81.47%   +0.02%     
==========================================
  Files          81       81              
  Lines       14204    14204              
==========================================
+ Hits        11569    11572       +3     
+ Misses       2635     2632       -3     
Impacted Files Coverage Δ
pymc/distributions/timeseries.py 22.35% <ø> (ø)
pymc/data.py 80.67% <0.00%> (ø)
pymc/sampling_jax.py 98.30% <0.00%> (ø)
pymc/distributions/continuous.py 97.23% <0.00%> (ø)
pymc/parallel_sampling.py 87.70% <0.00%> (+0.99%) ⬆️

@OriolAbril OriolAbril merged commit c892317 into pymc-devs:main Feb 20, 2022
@OriolAbril
Copy link
Member

Thanks for the PR!

@GallowayJ GallowayJ deleted the docstring_update branch February 21, 2022 10:53
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.

3 participants