Add scipy.optimize.Result to API docs

[cdeil]

The return value of scipy.optimize.minimize is a scipy.optimize.Result object as described here:
http://docs.scipy.org/doc/scipy-dev/reference/generated/scipy.optimize.minimize.html

But scipy.optimize.Result is currently missing from the scipy API docs.
I guess all that is needed is to list it in the docstring here?
https://github.com/scipy/scipy/blob/master/scipy/optimize/__init__.py
But I wasn't sure where to put it ... a new section at the end?

[pv]

I'd perhaps put it somewhere quite up, maybe immediately after minimize, or to a separate autosummary list after the first one.

The optimize module docstring is IMHO quite confusing overall and would be useful to restructure.

[cdeil]

I tried just listing the Result class in the docstring in optimize/__init__.py (see commit 97d5315).
This doesn't work.

@pv You mentioned that an overall restructure of the optimize docstring might be good ... can you do it?

Apart from that I tried went through the optimize tutorial and put a few (hopefully) improvements into 6c07eaa .
The main change is fixing some examples where keyword argument names have changed.

[coveralls]

Coverage remained the same when pulling 97d5315 on cdeil:optimize_docs into ba387ba on scipy:master.

[pv]

Thanks, looks good. The restructuring can be done later on.

[cdeil]

@pv Result still doesn't appear in the API docs. I wasn't able to figure out a way to include it (see comment above).
Do you know how to do it or should I open a new issue?

[rgommers]

Result should be added to __all__ in optimize/_minimize.py, then it'll appear.

[pv]

Fixed in 8594f29

[cdeil]

Result still doesn't show up at http://docs.scipy.org/doc/scipy-dev/reference/optimize.html .
@pv In 8594f29 you added Result to __all__ in optimize.py, @rgommers said it should be added to __all__ in _minimize.py, maybe that's why?

[pv]

The docs.scipy.org pages are updated only daily, not immediately.

[rgommers]

Since Result wasn't public before, it can be renamed I think. The name is way too generic imho. MinimizeResult?

[cdeil]

OK. It's in the docs now. Thanks!

+1 to changing to the more specific name of MinimizeResult.

[pv]

Yes, it's probably too generic, so +1 for rename

[dlax]

Ralf Gommers a écrit :

Since |Result| wasn't public before, it can be renamed I think. The name
is way too generic imho. |MinimizeResult|?

It's used in root() as well, so something like OptimizeResult may be better.

[argriffing]

If we have namespaces then what about optimize.Result? Not that it really matters to me.