Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add output documentation on monte_carlo_integral #35367

Merged
merged 1 commit into from
Apr 6, 2023

Conversation

davidlowryduda
Copy link
Contributor

@davidlowryduda davidlowryduda commented Mar 27, 2023

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

  • The title is concise, informative, and self-explanatory.
  • The description explains in detail what this PR is about.
  • I have linked a relevant issue or discussion.
  • I have created tests covering the changes.
  • I have updated the documentation accordingly.

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.
@vbraun vbraun merged commit f091c75 into sagemath:develop Apr 6, 2023
5 of 6 checks passed
@mkoeppe mkoeppe added this to the sage-10.0 milestone Apr 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants