Update number device classes #2580
Conversation
📝 WalkthroughWalkthroughThe documentation update in Changes
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 (1)
docs/core/entity/number.md (1)
75-75: SULPHUR_DIOXIDE Constant – Spelling ReviewThe description reads "Concentration of sulphure dioxide." Please confirm if the spelling "sulphure" is intentional or if it should be corrected to "sulphur" (or "sulfur") to maintain consistency with standard terminology.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/core/entity/number.md(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - developers-home-assistant
- GitHub Check: Header rules - developers-home-assistant
- GitHub Check: Pages changed - developers-home-assistant
🔇 Additional comments (21)
docs/core/entity/number.md (21)
34-34: APPARENT_POWER Constant – Formatting ConfirmationThe definition for
NumberDeviceClass.APPARENT_POWERappears unchanged content-wise and only reflects formatting adjustments.
36-36: AREA Constant – Formatting UpdatedThe
NumberDeviceClass.AREAentry now has corrected formatting for the supported units list. No content change is observed.
37-37: ATMOSPHERIC_PRESSURE Unit List – Verify Intended UnitsThe updated line for
NumberDeviceClass.ATMOSPHERIC_PRESSUREincludes bothmmHGandinHg. The PR objective mentioned updating the unit frominHgtommHgto align with sensor documentation. Please verify whether the inclusion ofinHgis intentional or if it should be removed.
40-40: CO2 Constant Renamed CorrectlyThe constant has been renamed to
CO2fromCARBON_DIOXIDEand the description is accurate.
41-41: CO Constant Renamed CorrectlyThe change from
CARBON_MONOXIDEtoCOis clear and consistent with the updated documentation.
46-46: DISTANCE Constant – Nautical Miles AddedThe supported units for
NumberDeviceClass.DISTANCEnow includenmi(nautical miles) as intended.
47-47: DURATION Constant – New AdditionThe new
NumberDeviceClass.DURATIONhas been added with a clear description and appropriate time units. This aligns with the sensor documentation pattern.
48-48: ENERGY Constant – Formatting and ClarityAlthough there is a tilde marking on this line, the content and description for
NumberDeviceClass.ENERGYremain consistent. The minor formatting adjustment is acceptable.
58-58: NITROGEN_DIOXIDE Constant – Formatting ReviewedThe definition of
NumberDeviceClass.NITROGEN_DIOXIDEappears correctly formatted with no content changes.
59-59: NITROGEN_MONOXIDE Constant – Formatting ReviewedThis definition is clear and matches the intended description.
60-60: NITROUS_OXIDE Constant – Formatting ReviewedThe
NumberDeviceClass.NITROUS_OXIDEentry is correctly formatted and the description is accurate.
61-61: OZONE Constant – Formatting ReviewedThe entry for
NumberDeviceClass.OZONEis updated in formatting while retaining its accurate description.
62-62: PH Constant – Formatting ReviewedThe
NumberDeviceClass.PHentry is now up-to-date and clearly stated.
63-63: PM1 Constant – Formatting ReviewedThe entry for
NumberDeviceClass.PM1is clear and accurate.
64-64: PM25 Constant – Formatting ReviewedThe
NumberDeviceClass.PM25constant is correctly formatted with an accurate description.
65-65: PM10 Constant – Formatting ReviewedThe presentation for
NumberDeviceClass.PM10is now clearer with the updated formatting.
68-68: PRECIPITATION Description – Clarification ConfirmedThe description for
NumberDeviceClass.PRECIPITATIONnow explicitly states "Accumulated precipitation," which enhances clarity.
70-70: PRESSURE Constant – Verify Unit ConsistencyFor
NumberDeviceClass.PRESSURE, the supported units still include bothmmHgandinHg. Since the update guidance mentioned changing the unit frominHgtommHg, please confirm ifinHgshould be removed to maintain consistency with the sensor device classes.
71-71: REACTIVE_POWER Constant – Formatting UpdatedThe
NumberDeviceClass.REACTIVE_POWERconstant is now properly formatted with a concise description.
78-78: VOLATILE_ORGANIC_COMPOUNDS_PARTS – New Addition ConfirmedThe new constant
NumberDeviceClass.VOLATILE_ORGANIC_COMPOUNDS_PARTSis added with the correct supported units and a clear description.
81-81: VOLUME_FLOW_RATE Constant – Formatting ReviewedThe definition for
NumberDeviceClass.VOLUME_FLOW_RATEappears clear and its formatting is consistent with the other entries.
Proposed change
This PR updates the docs for all number device classes. These should mostly match sensor device classes, but the dev docs weren't being updated as well as the dev docs for the sensor device classes. The following is done:
NumberDeviceClass.DURATIONNumberDeviceClass.VOLATILE_ORGANIC_COMPOUNDS_PARTSNumberDeviceClass.CO2NumberDeviceClass.COSensorDeviceClassdocsType of change
Additional information
Summary by CodeRabbit
New Features
Documentation