Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small documentation improvement: add unity #95

Closed
koocotte opened this issue Mar 23, 2024 · 2 comments · Fixed by #96
Closed

Small documentation improvement: add unity #95

koocotte opened this issue Mar 23, 2024 · 2 comments · Fixed by #96
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@koocotte
Copy link

Hello,

A small suggestion to improve documentation: explicit unity :

Document getHumidity() return a value between 0.0-1.0 or between 0.0-100.0, to be interpreted as a percent of humidity.

float getTemperature() returns temperature as °C or °F ?

Thanks

@RobTillaart
Copy link
Owner

Thanks for this issue,
Will have a look a the documentation to see how to improve.

@RobTillaart RobTillaart self-assigned this Mar 23, 2024
@RobTillaart RobTillaart added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 23, 2024
@RobTillaart RobTillaart linked a pull request Mar 24, 2024 that will close this issue
@RobTillaart
Copy link
Owner

Created a develop branch and a PR to improve the documentation.
Also includes some other pending updates.

RobTillaart added a commit that referenced this issue Mar 24, 2024
- fix #95, units of T & H
- update GitHub actions
- refactor **setType()** map invalid types to 0
- update readme.md
- update unit test (minor)
- minor edits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants