Skip to content

Fix typos in Potential docstring #6575

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

Merged

Conversation

chriswmann
Copy link

What is this PR about?
A recent update to the Potential function's code examples included minor typos in model.py. Specifically, minus signs were incorrectly included in the description of the constraints for the first two examples in two locations. Additionally, the warnings section of the docstring was too verbose. See #6574 for details.

I've simply removed the minus signs where they were incorrectly included, so that the examples are correct and consistent.
I've also shortened the warning to be more succinct.

Checklist

Major / Breaking Changes

N/A

New features

N/A

Bugfixes

N/A

Documentation

  • Remove spurious minus signs from the first two code examples in the Potential function
  • Shorten warning about applicability of Potential only to logp-based sampling

 * Remove spurious minus signs from the first two code examples in the Potential
   function

 * Shorten warning about applicability of Potential only to logp-based sampling
@codecov
Copy link

codecov bot commented Mar 7, 2023

Codecov Report

Merging #6575 (908ef44) into main (534a9ae) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #6575   +/-   ##
=======================================
  Coverage   92.01%   92.01%           
=======================================
  Files          91       91           
  Lines       15108    15108           
=======================================
  Hits        13901    13901           
  Misses       1207     1207           
Impacted Files Coverage Δ
pymc/model.py 89.52% <ø> (ø)

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