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.

Sign up for GitHub

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

Jump to bottom

DOC: Method "bisect" for root_scalar lacks correct argument list #16796

Closed
asberk opened this issue Aug 6, 2022 · 1 comment · Fixed by #16799
Closed

DOC: Method "bisect" for root_scalar lacks correct argument list #16796

asberk opened this issue Aug 6, 2022 · 1 comment · Fixed by #16799
Labels
defect A clear bug or issue that prevents SciPy from being installed or used as expected Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.optimize
Milestone
1.10.0

Comments

@asberk
Copy link
Contributor

asberk commented Aug 6, 2022

Describe your issue.

In the documentation for root_scalar with method='bisect', there is no mention of having to use the bracket argument. This is also the case for other methods, such as brentq, which take a bracket argument not shown by the documentation sub-page.

Reproducing Code Example

NA

Error message

NA

SciPy/NumPy/Python version information

SciPy 1.9.0
@asberk asberk added the defect A clear bug or issue that prevents SciPy from being installed or used as expected label Aug 6, 2022
@tupui tupui added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.optimize labels Aug 7, 2022
@tupui
Copy link
Member

tupui commented Aug 7, 2022

Hi @asberk thank you for reporting. Indeed it's missing. Would you like to make a PR to improve the doc?

@asberk asberk mentioned this issue Aug 7, 2022
Merged
@tupui tupui added this to the 1.10.0 milestone Aug 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
defect A clear bug or issue that prevents SciPy from being installed or used as expected Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.optimize
Projects
None yet
Milestone
1.10.0
Development

Successfully merging a pull request may close this issue.

DOC: optimize.root_scalar: improve parametrization of methods asberk/scipy
2 participants
@asberk @tupui