Improve docstrings in buildh files

patrickfuchs / buildH

:computer: Build hydrogen atoms from united-atom molecular dynamics of lipids and calculate the order parameters.

https://buildh.readthedocs.io/

BSD 3-Clause "New" or "Revised" License

14 stars 7 forks source link

Closed HubLot closed 3 years ago

HubLot commented 3 years ago

This PR should fix #150

I made various improvements/update of the docstrings of the functions :

put backquotes when needed
create code snippets when appropriate for proper rendering in HTML
Correct Notes into Note
Update docstrings in core.py to reflect changes made previously in the code (functions moved for example)
remove dict for dictionary

patrickfuchs commented 3 years ago

Great, thanks a lot @HubLot! I only saw a minor nitpick.