Add output documentation on monte_carlo_integral #35367
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.
This small commit adds an OUTPUT description to the documentation of monte_carlo_integral. The wording of the output is essentially taken from numerical_integral.
This is a nearly trivial documentation change, made after having a conversation with someone using monte-carlo-integration and being confused at the output. Specifically, the output is the tuple
(approximate_integral, approximate_error_bound)
. The error bound wasn't documented.I will also note that this is my first direct contribution in the github era - please let me know if there is something I should be doing here.
📝 Checklist