Update noaa_tides.markdown #42399
Update noaa_tides.markdown #42399
Conversation
Added additional attributes
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for newly exposed attributes in the NOAA Tides integration. The update provides users with detailed information about the available attributes for the sensor.noaa_tides entity, including timing and height information for upcoming tide events.
Key changes:
- Added a new "Entities and Attributes" section to document the sensor's attributes
- Documented nine attributes related to tide event timing and measurements
- Included a clarifying note about the relationship between low and high tide times
|
|
||
| ## Entities and Attributes | ||
|
|
||
| This plugin exposes one entity `sensor.noaa_tides` which has a native value that contains the next tide event |
There was a problem hiding this comment.
Replace 'plugin' with 'integration' to align with Home Assistant terminology. Home Assistant uses 'integration' to refer to its components.
|
|
||
| | Attribute | Description | ||
| | --------- | ----------- | ||
| | next_tide_event_time | Minute of next tide event in %Y-%m-%dT%H:%M format, in the timezone as configured above | |
There was a problem hiding this comment.
The description says 'Minute of next tide event' but should be 'Time of next tide event' since the format includes date, hour, and minute information, not just the minute.
| | next_tide_event_time | Minute of next tide event in %Y-%m-%dT%H:%M format, in the timezone as configured above | | |
| | next_tide_event_time | Time of next tide event in %Y-%m-%dT%H:%M format, in the timezone as configured above | |
|
|
||
| | Attribute | Description | ||
| | --------- | ----------- | ||
| | next_tide_event_time | Minute of next tide event in %Y-%m-%dT%H:%M format, in the timezone as configured above | |
There was a problem hiding this comment.
The datetime format should be described using natural language instead of format codes. Consider: 'Time of next tide event in ISO 8601 format (YYYY-MM-DDTHH:MM), in the configured timezone'.
| | next_tide_event_time | Minute of next tide event in %Y-%m-%dT%H:%M format, in the timezone as configured above | | |
| | next_tide_event_time | Time of next tide event in ISO 8601 format (YYYY-MM-DDTHH:MM), in the configured timezone | |
| This plugin exposes one entity `sensor.noaa_tides` which has a native value that contains the next tide event | ||
| information as a string, formatted as "[High|Low] tide at H:MM AM/PM". There are additional attributes that can | ||
| be used for display or automation as follows: | ||
|
|
There was a problem hiding this comment.
Add a blank line before the table to ensure proper Markdown rendering across different parsers.
|
Seems this is related to an open PR in Core. Please. Start a fresh new PR and target this against the |
2 participants
Added additional attributes
Proposed change
Type of change
Spelling, grammar or other readability improvements (
currentbranch).Adjusted missing or incorrect information in the current documentation (
currentbranch).Added documentation for a new integration I'm adding to Home Assistant (
nextbranch).Added documentation for a new feature I'm adding to Home Assistant (
nextbranch).Removed stale or deprecated documentation.
Adding documentation for new attributes in an existing integration.
Additional information
Checklist
currentbranch.nextbranch.