Make a usage example in the docstring

[cmp0xff]

I think it is a bit easier for our future selves if we have have a usage example in the docstring. Something like

https://github.com/kausalflow/hamilflow/blob/04ea13c523f8beb7d48123754ec96251b98b5c49/hamilflow/models/harmonic_oscillator.py#L141-L151

_Ursprünglich gepostet von @emptymalei in https://github.com/kausalflow/hamilflow/pull/58#discussion_r1697441313_

[cmp0xff]

I think the docstrings of the classes are too long.

• The description of the initialising parameters can be moved to the initialisers.
• The example can go to __call__.
• We can make referring links between docstrings, like https://github.com/matplotlib/matplotlib/blob/1b082070115e0c82082f560b0cc4c728357bfd7e/lib/matplotlib/axes/_axes.py#L86, where all syntaxes in `` are links referring to other docs, see https://matplotlib.org/stable/api/_as_gen/matplotlib.axes.Axes.html#matplotlib.axes.Axes for the results.

Unfortunately I did not find a documentation for how the syntaxes are rendered in matplotlib. However we do not need to make things too complicated for us, either.

What do you think @emptymalei ?