Fix integrate.fixed_quad docstring to indicate None return value #5083
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.
I noticed that
scipy.integrate.fixed_quad
return a tuple with the second element always equal toNone
, that is not documented (I had to look at the source code to realize why I was getting a tuple back instead of just a float). This has been in the code for a long time and it looks like previous versions of the docstring properly accounted for this, but the current version does not.I assume there is some legacy reason for always returning a None, and a quick search of Github shows that most people use it as something like:
I'm not sure my proposed docstring is optimally worded, but I'm happy to adjust it if others have suggestions.