search

marrink-lab / polyply_1.0

Generate input parameters and coordinates for atomistic and coarse-grained simulations of polymers, ssDNA, and carbohydrates
Apache License 2.0
123 stars 21 forks source link

fix documentation #3

Open fgrunewald opened 4 years ago

fgrunewald commented 4 years ago

Docstrings need to either be added or put into proper format

fgrunewald commented 2 years ago

If you want to typehint this completely (optional), you can do something like templates: dict[str, vermouth.molecule.Block], indicating its keys are strings and values are Blocks. You'll still need to tell the str is a resname. And I'm not sure how much sphinx/autodoc/apidoc likes the not-4-spaces indent. But that we can fix later

Originally posted by @pckroon in #29