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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: error in scipy.integrate.DOP853 #19008

Closed
keithbriggs opened this issue Aug 3, 2023 · 2 comments · Fixed by #19047
Closed

DOC: error in scipy.integrate.DOP853 #19008

keithbriggs opened this issue Aug 3, 2023 · 2 comments · Fixed by #19047
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution scipy.integrate
Milestone

Comments

@keithbriggs
Copy link

Issue with current documentation:

This doesn't make sense:

Note that this is not a literate translation

I suppose it was meant to be:

Note that this is not a literal translation

Idea or request for content:

No response

Additional context (e.g. screenshots, GIFs)

No response

@keithbriggs keithbriggs added the Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org label Aug 3, 2023
@keithbriggs
Copy link
Author

This bit isn't too good either:

Here rtol controls a relative accuracy (number of correct digits), while atol controls absolute accuracy (number of correct decimal places).

For most people, "digits" and "decimal places" are the same thing.

@j-bowhay j-bowhay added scipy.integrate good first issue Good topic for first contributor pull requests, with a relatively straightforward solution labels Aug 5, 2023
@j-bowhay
Copy link
Member

j-bowhay commented Aug 5, 2023

PR welcome for the doc fix although please sure be sure to skip the appropriate CI jobs by adding [skip actions] [skip cirrus] at the end of the commit message.

This bit isn't too good either:

Here rtol controls a relative accuracy (number of correct digits), while atol controls absolute accuracy (number of correct decimal places).

For most people, "digits" and "decimal places" are the same thing.

I personally think this is fine, in numerical analysis digits tend to refer to significant figures rather than decimal places so this description is correct.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org good first issue Good topic for first contributor pull requests, with a relatively straightforward solution scipy.integrate
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants