search

ulfsri / pyAlicat

Python API for acquisition and control of Alicat mass flow meters and controllers.
https://ulfsri.github.io/pyAlicat/
MIT License
0 stars 1 forks source link

Docstrings #98

Closed GraysonBellamy closed 5 months ago

GraysonBellamy commented 6 months ago

🚀 Feature Request

Applies to all packages best let's standardize and generate consistent docstrings for all our code. I would recommend Google's python docstring style guide. https://google.github.io/styleguide/pyguide.html#s3.8.1-comments-in-doc-strings

🔈 Motivation

Standardization of code and documentation to make everything understandable.

🛰 Alternatives

There's sphinx (reStructuredText) or numpy/scipy styles as well. I don't have a huge preference but let's just pick one.

📎 Additional context

GraysonBellamy commented 6 months ago

All done in device.py. Need to update some of the comm.py to the write format to remain consistent

ULibrady commented 5 months ago

Docstrings are all consistent