Magic methods not part of documentation about odl HOT 8 CLOSED

Partial fix of this committed, we can provide a list in conf.py of methods not to skip. i added __init__ here but we may want the others as well?

from odl.

I also added __eq__ and __contains__, any more we want to add?

from odl.

__init__() is definitely needed, or alternatively, we can move the code from __init__() into the class docstring. I don't think we need any one of the other functions in the doc. Many double underscores look sort of frightening.

from odl.

pep-258

The class constructor should be documented in the docstring for its __init__ method.

How about _lincomb and _multiply, the info in these somehow need to be exposed, no?

from odl.

It would be great if one could just "put" the documentation of LinearSpace.lincomb() to into the child classes instead of documenting the private ones. The same for multiply(), divide() etc. Any chance to do this with Spinx?

You're right about the constructor doc, let's keep it as it is.

from odl.

I'll see what we can do with "reference doc"

from odl.

We need to remove __hash__, then we can close this.

from odl.

I see __hash__ in the config file, closing.

from odl.