search

Sensirion / arduino-i2c-scd4x

Arduino library for Sensirion SCD4x sensors
BSD 3-Clause "New" or "Revised" License
48 stars 19 forks source link

Fix/improve param documentation for readMeasurementTicks #2

Closed marcelstoer closed 3 years ago

marcelstoer commented 3 years ago

Depending on how you look at it the parameter documentation for readMeasurementTicks is either misleading or outright wrong (for temperature).

MBjoern commented 3 years ago

Hi Marcel

Looks like you don't like physical units in formulas. The documentation for temperature is not a line of code, it's a mathematical equation.

Best regards

marcelstoer commented 3 years ago

I don't mind the units at all. I removed them for the documentation to be consistent with the one for getTemperatureOffsetTicks and setTemperatureOffsetTicks (no units for both). The real issue was the formula for the temperature parameter that really confused me i.e. can easily be misinterpreted.