DOC: fix documentation for scipy.optimize.brenth #14729
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tylerjereddy
added
the
Documentation
See scipy#14390. This commit adds a proper reference for the brenth method, along with the necessary citation.
Move See Also section to the correct place, and fix the DOI link by using the `:doi:` directive.
Awesome, happy I could help :D |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Reference issue
Closes GitHub Issue #14390
What does this implement/fix?
This commit fixes the documentation for
scipy.optimize.brenth, providing a proper citation along with some additional information about the algorithm used.Additional information
Relevant papers for double-checking:
1.) Original paper
2.) Subsequent paper describing the method as "similar to Brent's method, but with hyperbolic interpolation".