martius-lab / cluster_utils

https://cluster-utils.readthedocs.io/stable/

Other

12 stars 0 forks source link

Closed luator closed 5 months ago

luator commented 6 months ago

Ass sugested in #95, add dedicated page for API documentation. The idea is to list all functions here, that are supposed to be used by the user.

TODO

[ ] I went through examples to figure out which functions are relevent. Did I miss something?
[x] Add/extend docstrings of these functions
[ ] Ideally also add type hints

luator commented 6 months ago

@mseitzer Would be great if you could help me with the docstrings here, as I'm not so familiar with everything. Feel free to push to the branch.

luator commented 5 months ago

I added missing docstrings now based on what I understood from reading the code. Please let me know if I got something wrong.

This is what the rendered HTML looks like: 2024-06-04 15 44 27 d7242e32ee33