Create automatic help and documentation.

borevitzlab / timestreamlib

DEPRECATED. Please use the current version of the TimeStream tools at https://gitlab.com/appf-anu/pyts2.

https://gitlab.com/appf-anu/pyts2

GNU General Public License v3.0

7 stars 4 forks source link

Create automatic help and documentation. #143

Closed Joelgranados closed 9 years ago

Joelgranados commented 9 years ago

Both are related. The help needs to flow from the relative classes and the documentation is just a pretty way of presenting the help. its a big chunck of code, so I'll sprinkle some comments to ease the review.

coveralls commented 9 years ago

Coverage decreased (-1.33%) when pulling 6ab9514f17b90df8ce70f478671abeb2d935f333 on Joelgranados:helpconfig into aa5d3bd2a2f892df59861230d5b31f61fd0dff5e on borevitzlab:next.

kdm9 commented 9 years ago

Looks pretty good to me. Will let chuong have a poke before we merge it though.

chuong commented 9 years ago

I am not sure how I can look at this. Just go ahead as you like.

coveralls commented 9 years ago

Coverage decreased (-1.25%) when pulling 18538853079a1a57031827355d256637b8454d31 on Joelgranados:helpconfig into aa5d3bd2a2f892df59861230d5b31f61fd0dff5e on borevitzlab:next.

kdm9 commented 9 years ago

Other than my line notes above, LGTM

kdm9 commented 9 years ago

You can rebase it after addressing those, or just merge it.

coveralls commented 9 years ago

Coverage decreased (-1.25%) when pulling 6adeb642b485687d53316873bdd6d3cdfe13369a on Joelgranados:helpconfig into aa5d3bd2a2f892df59861230d5b31f61fd0dff5e on borevitzlab:next.

coveralls commented 9 years ago

Coverage decreased (-1.25%) when pulling 6adeb642b485687d53316873bdd6d3cdfe13369a on Joelgranados:helpconfig into aa5d3bd2a2f892df59861230d5b31f61fd0dff5e on borevitzlab:next.