Add docstrings to public API for v5

[SimonBlanke]

Add docstrings to all classes and methods of the public API

[Wassaf001]

Hey, I would like to work on this issue.

Can you please guide me on how to proceed.

[SimonBlanke]

Hello @Wassaf001,

I already added doc strings some time ago. Forgot to close this issue.

I am currently working on a new API for v5. This would require some new doc strings for the optimizer classes. You could help out with that.

The optimizer classes are in this file. You can draw the docstrings from their GFO counterpart (GFO is Hyperactive's optimization backend).

If you work on this it is important, that you branch out from v5-API-design. Since those docstring do not belong in the master, yet. When you take the docstring from GFO, please ask yourself if the explanation is sufficient and clear. I wrote these, but that does not mean that they are helpful for users. So you could evaluate if the docstrings are good from your perspective and help me improve them.

[Wassaf001]

ok thank you for the detailed explanation.