Fix typos in Potential docstring #6575
Merged
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.
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