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 description of "direc" parameter of "fmin_powell" #13511

Closed
dwight200 opened this issue Feb 5, 2021 · 1 comment
Closed

DOC: error in description of "direc" parameter of "fmin_powell" #13511

dwight200 opened this issue Feb 5, 2021 · 1 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.optimize
Milestone

Comments

@dwight200
Copy link
Contributor

I think there is a small mistake in the otherwise useful documentation introduced in #9227. Specifically the default is described as np.ones((N, N)) but should be np.eye((N, N))?

Current documentation:

   direc : ndarray, optional
          Initial fitting step and parameter order set as an (N, N) array, where N
          is the number of fitting parameters in `x0`. Defaults to step size 1.0
          fitting all parameters simultaneously (``np.ones((N, N))``). To

Source code (scipy/optimize/optimize.py:_minimize_powell):

      if direc is None:
         direc = eye(N, dtype=float)
@tupui tupui added Documentation Issues related to the SciPy documentation. Also check https://github.com/scipy/scipy.org scipy.optimize labels Feb 6, 2021
@tupui
Copy link
Member

tupui commented Feb 6, 2021

Indeed, thanks you for noticing this. Would you do a PR to fix this? Let me know if you want me to do it for you otherwise @dwight200.

@tupui tupui added the good first issue Good topic for first contributor pull requests, with a relatively straightforward solution label Feb 9, 2021
dwight200 pushed a commit to dwight200/scipy that referenced this issue Feb 9, 2021
andyfaff added a commit that referenced this issue Feb 9, 2021
DOC: optimize: fix minor doc error in 'fmin_powell' (#13511)
@andyfaff andyfaff closed this as completed Feb 9, 2021
@tylerjereddy tylerjereddy added this to the 1.7.0 milestone Feb 11, 2021
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.optimize
Projects
None yet
Development

No branches or pull requests

4 participants