search

olsonk / pyRosita

0 stars 0 forks source link

Add descriptive comment headers to each class #2

Closed olsonk closed 6 years ago

olsonk commented 6 years ago

Each class has a small comment header describing its attributes. This section needs to be fleshed out with descriptions of each class method, along with how they are used.

olsonk commented 6 years ago

Please see this commit. This follows Python Docstring style guide and general commenting conventions to provide documentation. Should I continue with this format?

jteller commented 6 years ago

Yes -- that format looks great!

olsonk commented 6 years ago

Completed documenting rt_hardware and sequencer files. Documented all classes and class methods.

See this commit for rt_hardware docs. See this commit for sequencer docs.