Feature/batch/units in docs

MideTechnology / endaq-python

A comprehensive, user-centric Python API for working with enDAQ data and devices

MIT License

25 stars 12 forks source link

Feature/batch/units in docs #151

Closed CrepeGoat closed 2 years ago

CrepeGoat commented 2 years ago

This PR adds to endaq.batch a description of the functions' output units to each respective docstring. (This also fixes one erroneous units conversion to the peak PVSS; @shanlyMIDE / @CFlaniganMide can you confirm this change is right?)

Docs rendered here: https://docs.endaq.com/en/feature-batch-units-in-docs/endaq/batch.html

CrepeGoat commented 2 years ago

Thanks for double-checking my math @CFlaniganMide! @shanlyMIDE since this is mainly a UX feature that you requested, I'm still going to wait on an approval from you before merging.