Add docs? (if needed)

[IAlibay]

Adding this issue here as it might be a feature of the ongoing GSoC.

It might be worth consider what, if any, docs should be added / deployed for panedr.

[IAlibay]

General addition of class docstrings would be a good starting point @BFedder - it'll let you double check that what you are making the same assumptions about how the classes are behaving as how @jbarnoud wrote them.

[jbarnoud]

The code tries to follow the gromacs code as much as possible. It is a good place to start to understand.

[orbeckst]

There should be minimal docs — we tend to preach that any package should have

• docs
• tests at sufficient coverage
• defined API

so we should also have them for panedr.

[jbarnoud]

There used to be a single exposed function and it was documented in the readme 😛