search

mwhit74 / mlob

Determinate structure moving load analysis
MIT License
8 stars 1 forks source link

Add docstrings #5

Closed mwhit74 closed 7 years ago

mwhit74 commented 7 years ago

Add properly formatted docstrings. Pydoc and help should work with docstrings if done correctly.

mwhit74 commented 7 years ago

Good docstrings exist via pydoc.

Less than well formatted and clean html documentation exists https://mwhit74.github.io/docs/mlob_docs/docs.html. Still need to clean this up but I want something more automated and I feel like it can be automated so that I don't have to fiddle with it every time I add something to the docs. However, I am not counting that as good documentation. It is extra stuff that can be done outside of mlob development.