Update number device classes #37709
Update number device classes #37709
Conversation
home-assistant
bot
added
current
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the integration documentation file to refine the descriptions of various device classes. Modifications include expanded and clarified unit options for measurements such as atmospheric pressure, battery level, gas concentrations, distance, and wind speed. Additionally, two new device classes—duration and volatile_organic_compounds_parts—have been introduced with defined measurement units and standards. Changes
Sequence Diagram(s)Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/number.markdown (2)
58-58: Clarify Gas Device Class DescriptionThe
gasdevice class now reads as “Gasvolume in m³, ft³ or CCF”. For improved readability, consider using “Gas volume” (with a space) to enhance clarity.
75-75: Review Precipitation Intensity UnitsThe
precipitation_intensityentry lists units as "in/d, in/h, mm/d or mm/h". There appears to be a potential duplication in the abbreviations for inches (i.e. “in/d, in/h”) which might benefit from a more descriptive format (e.g., "inches per day" and "inches per hour") to avoid ambiguity.🧰 Tools
🪛 LanguageTool
[duplication] ~75-~75: Possible typo: you repeated a word.
Context: ...on_intensity**: Precipitation intensity in in/d, in/h, mm/d or mm/h - pressure: P...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/number.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/number.markdown
[duplication] ~75-~75: Possible typo: you repeated a word.
Context: ...on_intensity**: Precipitation intensity in in/d, in/h, mm/d or mm/h - pressure: P...
(ENGLISH_WORD_REPEAT_RULE)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (8)
source/_integrations/number.markdown (8)
45-49: Enhanced Device Class DescriptionsThe descriptions for
atmospheric_pressure,battery,blood_glucose_concentration,carbon_dioxide, andcarbon_monoxidehave been updated to reflect proper units and corrected naming (notably the correction inblood_glucose_concentration). These changes improve clarity and consistency with the sensor device class documentation.
51-54: Updated Data, Distance, and Added Duration Device ClassesThe
data_rateanddata_sizeentries now list comprehensive unit options, and thedistancedevice class correctly includes nautical miles ("nmi"). Moreover, the newly addeddurationdevice class clearly specifies its measurement units (d, h, min, s, or ms), ensuring alignment with the overall documentation style.
59-59: Improved Humidity Device Class DescriptionThe updated
humidityentry now clearly indicates that the measurement is expressed as a percentage by including the "%" symbol. This small change enhances user understanding.
62-62: Consistent Moisture Device Class DescriptionThe
moisturedevice class description now explicitly mentions that the value represents a percentage. This update brings it in line with similar entries such asbatteryandhumidity.
63-63: Enhanced Monetary Device Class DescriptionReferencing the ISO 4217 standard in the
monetarydevice class provides necessary context and clarifies the expected format for monetary values.
71-71: Clarified PM10 DescriptionThe
pm10device class now explicitly states that particulate matter concentrations are measured in µg/m³. This clarification supports consistency with other particulate matter documentation.
84-84: New VOC Parts Device Class AddedThe addition of the
volatile_organic_compounds_partsdevice class, which specifies the ratio in ppm or ppb, effectively fills a gap in the documentation. This new entry is clear and consistent with the style of the other device classes.
91-91: Expanded Wind Speed DocumentationIncluding "Beaufort" as a valid unit for the
wind_speeddevice class broadens the range of acceptable measurement units and aligns well with user expectations. This update is straightforward and well-integrated.
Proposed change
This PR updates the docs for all number device classes. These should mostly match sensor device classes, but the docs weren't being updated as well as the docs for the sensor device classes. The following is done:
durationvolatile_organic_compounds_partsblood_glucose_concentrationspellingSensorDeviceClassdocsIf we want to revert some of the changes (i.e. revert removal of oxford commas), we should also change them for the sensor device class docs (linked above). I've removed them for now to match with the more up-to-date sensor docs.
This PR is similar to the matching dev docs PR: home-assistant/developers.home-assistant#2580
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation