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: Clarified the meaning of optional arguments in optimize.leastsq #17883

Merged
merged 4 commits into from
Feb 4, 2023

Conversation

madphysicist
Copy link
Contributor

https://stackoverflow.com/q/75278309/2988730 and my own experience indicate that the docs are not quite clear on this point

[ci skip]

https://stackoverflow.com/q/75278309/2988730 and my own experience indicate that the docs are not quite clear on this point
@madphysicist madphysicist changed the title DOC: Clarified the meaning of optional arguments DOC: Clarified the meaning of optional arguments in optimize.leastsq Jan 30, 2023
@j-bowhay j-bowhay added scipy.optimize Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org labels Jan 30, 2023
@mdhaber
Copy link
Contributor

mdhaber commented Jan 30, 2023

Thanks! When gh-17878 merges, I'll go ahead and merge this.

@madphysicist as a follow-up, would you consider doing something like gh-17837 for curve_fit? With that change, curve_fit would return a bunch object instead of a plain tuple when full_output=False. The first two outputs can be unpacked (for backward compatibility), but the remaining return values would still be accessible as attributes. This would allow full_output to be deprecated.

If so, I'd suggest sending a message to the mailing list like this because public API changes need to be approved.

@mdhaber mdhaber merged commit 6a3b637 into scipy:main Feb 4, 2023
@j-bowhay j-bowhay added this to the 1.11.0 milestone Feb 8, 2023
@madphysicist madphysicist deleted the patch-1 branch March 27, 2023 02:46
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 scipy.optimize
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants