Revise docstrings about oemof-solph HOT 4 CLOSED

Check numpy documentation and pep 257.

from oemof-solph.

There was an open question at the meeting, where to write the docstring of a class. In pep257 I found:

"The docstring for a class should summarize its behavior and list the public methods and instance variables. If the class is intended to be subclassed, and has an additional interface for subclasses, this interface should be listed separately (in the docstring). The class constructor should be documented in the docstring for its init method. Individual methods should be documented by their own docstring."

from oemof-solph.

Searching for numpydoc examples I found examples writing the docstring in the class level instead of in the init method.

Let us use this for future docstrings and change the old ones (if necessary) step by step.

from oemof-solph.

Completed with commit d3375f0.

from oemof-solph.