Reddit Integration: allow fetching user posts #34345
Conversation
…ant#34193) Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
…4196) Co-authored-by: Franck Nijhof <[email protected]>
* Clarification for raw tip voltage sensor, add ha category * add comma
…t#34217) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…34218) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…34216) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: TheJulianJES <[email protected]>
Closing quote missing from the template
home-assistant#34244) * Update IMAP docs on use of App passwords and removed Microsoft support * Suggested update Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * Tiny tweak --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Co-authored-by: c0ffeeca7 <[email protected]>
…e-assistant#34251) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…34250) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
…#34252) Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
* Link to all entities that is support in group Link to all entities that are currently supported in a group * tiny tweak --------- Co-authored-by: c0ffeeca7 <[email protected]>
…tant#34257) * Cleanup mqtt publish action template option documentation * Missed instance
WalkthroughWalkthroughThe recent updates primarily focus on enhancing documentation, refining configuration settings, and updating dependencies within the Home Assistant project. Notable changes include a minor version increment for the 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 as PR comments)
Additionally, you can add 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: 15
Outside diff range, codebase verification and nitpick comments (13)
source/_integrations/reddit.markdown (1)
68-71: Documentation forredditorsfield lacks examples and detailed guidance.The current documentation only provides a basic description of the
redditorsfield without any examples or further guidance on its usage. Please update the documentation to include clear examples and instructions.
- The
redditorsfield is described as a list of users you want to get data on, but no examples are provided.Analysis chain
Verify documentation and examples for
redditorsfield.Ensure that the documentation provides clear examples and guidance on using the new
redditorsfield effectively.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify documentation for the new `redditors` field. # Test: Search for examples and guidance related to the `redditors` field in the documentation. Expect: Clear and comprehensive documentation. rg --type markdown 'redditors'Length of output: 130
Script:
#!/bin/bash # Extract more context around the occurrences of "redditors" in markdown files to verify documentation and examples. rg --type markdown 'redditors' -A 5 -B 5Length of output: 1355
source/_integrations/logbook.markdown (1)
17-17: Add alt text to improve accessibility.The image should have alternate text to improve accessibility for users with visual impairments.
- <img src='/images/screenshots/logbook.png' style='margin-left:10px; float: right;' height="100" /> + <img src='/images/screenshots/logbook.png' alt='Logbook screenshot' style='margin-left:10px; float: right;' height="100" />Tools
Markdownlint
17-17: null
Images should have alternate text (alt text)(MD045, no-alt-text)
source/_posts/2024-08-08-works-with-home-assistant-becomes-part-ohf.markdown (1)
39-39: Consider adding a comma after the introductory phrase.Adding a comma after "From now on" can improve readability by clearly separating the introductory phrase from the main clause.
- From now on the program will be certifying individual devices instead of whole brands. + From now on, the program will be certifying individual devices instead of whole brands.Tools
LanguageTool
[typographical] ~39-~39: Consider adding a comma after this introductory phrase.
Context: ...proving the program on several fronts. From now on the program will be certifying individu...(FROM_NOW_ON_COMMA)
source/voice_control/thirteen-usd-voice-remote.markdown (1)
98-98: Consider using a comma before 'and'.Adding a comma before "and" can improve readability by clearly separating the independent clauses.
- for Assist to find you're done speaking and it can start processing your command. + for Assist to find you're done speaking, and it can start processing your command.Tools
LanguageTool
[uncategorized] ~98-~98: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... for Assist to find you're done speaking and it can start processing your command. ...(COMMA_COMPOUND_SENTENCE)
source/_integrations/wled.markdown (3)
108-108: Ensure complete sentences by including a subject.To form a complete sentence, consider adding "It" at the beginning.
- Toggles the WLED Timer. + It toggles the WLED Timer.Tools
LanguageTool
[style] ~108-~108: To form a complete sentence, be sure to include a subject.
Context: ...### Nightlight Toggles the WLED Timer. Can be configured on the WLED itself under ...(MISSING_IT_THERE)
114-114: Ensure complete sentences by including a subject.To form a complete sentence, consider adding "It" at the beginning.
- Toggles the synchronization between multiple WLED devices. + It toggles the synchronization between multiple WLED devices.Tools
LanguageTool
[style] ~114-~114: To form a complete sentence, be sure to include a subject.
Context: ...nization between multiple WLED devices. Can be configured on the WLED itself under ...(MISSING_IT_THERE)
115-115: Remove trailing spaces.There are trailing spaces at the end of this line. Removing them can improve code cleanliness.
- Can be configured on the WLED itself under + Can be configured on the WLED itself underTools
Markdownlint
115-115: Expected: 0 or 2; Actual: 1
Trailing spaces(MD009, no-trailing-spaces)
source/_integrations/conversation.markdown (1)
169-169: Consider using "can" instead of "is able to".For a more concise expression, consider using "can return" instead of "is able to return".
- This action is able to return [response data](/docs/scripts/perform-actions/#use-templates-to-handle-response-data). + This action can return [response data](/docs/scripts/perform-actions/#use-templates-to-handle-response-data).Tools
LanguageTool
[style] ~169-~169: As a shorter alternative for ‘able to’, consider using “can”.
Context: ... | This action is able to return [response data](/docs/scripts/pe...(BE_ABLE_TO)
source/_integrations/todo.markdown (1)
48-48: Consider adding a comma before "or".To improve readability, consider adding a comma before "or" as it connects two independent clauses.
- actions provided by some to-do list entities are described below or you can read more about [actions](/docs/scripts/perform-actions/). + actions provided by some to-do list entities are described below, or you can read more about [actions](/docs/scripts/perform-actions/).Tools
LanguageTool
[uncategorized] ~48-~48: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... to-do list entities are described below or you can read more about [actions](/docs...(COMMA_COMPOUND_SENTENCE)
source/_integrations/calendar.markdown (1)
145-145: Consider adding a comma before "or".To improve readability, consider adding a comma before "or" as it connects two independent clauses.
- The actions provided by some calendar {% term entity %} are described below or you can read more about [actions](/docs/scripts/perform-actions/). + The actions provided by some calendar {% term entity %} are described below, or you can read more about [actions](/docs/scripts/perform-actions/).Tools
LanguageTool
[uncategorized] ~145-~145: Use a comma before ‘or’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ar {% term entity %} are described below or you can read more about [actions](/docs...(COMMA_COMPOUND_SENTENCE)
source/_integrations/homeassistant.markdown (1)
215-215: Simplify phrasing.Consider simplifying the phrasing by using "inside" instead of "inside of."
- inside of `homeassistant:` + inside `homeassistant:`Tools
LanguageTool
[style] ~215-~215: This phrase is redundant. Consider using “inside”.
Context: ... %} file, you must make sure it is done inside ofhomeassistant:or it will fail. {% en...(OUTSIDE_OF)
source/_integrations/reolink.markdown (1)
38-39: Clarify Password Requirements.The addition specifying allowed characters in Reolink passwords is a helpful clarification. Consider rephrasing for better readability.
- The password used for the Reolink device can only contain characters `a-z, A-Z, 0-9 or @$*~_-+=!?.,:;'()[]`. + The password for the Reolink device can only include the following characters: `a-z, A-Z, 0-9, @$*~_-+=!?.,:;'()[]`.Tools
LanguageTool
[formatting] ~39-~39: Did you mean “?”
Context: ...link device can only contain charactersa-z, A-Z, 0-9 or @$*~_-+=!?.,:;'()[]. Other special characters will...(MULTIPLE_PUNCTATION_MARKS_1)
source/_integrations/mqtt.markdown (1)
Line range hint
1088-1114: Add a comma for clarity.Consider adding a comma after "editor" for improved readability.
- If you want to send JSON using the YAML editor then you need to format/escape it properly. + If you want to send JSON using the YAML editor, then you need to format/escape it properly.Tools
LanguageTool
[typographical] ~1114-~1114: Consider adding a comma.
Context: ... want to send JSON using the YAML editor then you need to format/escape it properly. ...(IF_THEN_COMMA)
| ## Matter OTA device updates | ||
|
|
||
| The Matter standard supports OTA (Over-the-Air) updates optionally. Matter devices that support Matter updates will have an [update entity](/integrations/update). Furthermore, the CSA DCL (Distributed Compliance Ledger) stores firmware update information. Home Assistant reads firmware update information directly from the DCL to learn about available updates. By default, the integration checks every 12 hours for an update. If you want to force an update check, use the `homeassistant.update_entity` [action](/integrations/homeassistant/) with the update entity as the target. | ||
| The Matter protocol supports OTA (Over-the-Air) software updates. But the OTA software update is an optional feature for Matter devices, so not all Matter devices implement it. Home Assistant creates an update entity for every Matter device which does support Matter updates. | ||
|
|
||
| The CSA operates a Distributed Compliance Ledger (DCL) which provides metadata for firmware updates. By default, the Matter update entities check the DCL every 12 hours for updates. If you want to force an update check, use the `homeassistant.update_entity` [action](/integrations/homeassistant/), with the update entity as the target. Currently, Eve and Nanoleaf are using the DCL to provide updates. It is expected that in future, more and more firmware updates become available through the DCL. | ||
|
|
||
| <p class='img'> | ||
| <img src='/images/integrations/matter/matter_ota_message.png' alt='Matter device OTA update message'> | ||
| Notification of an OTA update for a Matter device | ||
| </p> |
There was a problem hiding this comment.
Clarify language consistency for international audiences.
The phrase "in future" is British English. Consider using "in the future" for consistency with American English, which is more commonly used in technical documentation.
- It is expected that in future, more and more firmware updates become available through the DCL.
+ It is expected that in the future, more and more firmware updates become available through the DCL.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Matter OTA device updates | |
| The Matter standard supports OTA (Over-the-Air) updates optionally. Matter devices that support Matter updates will have an [update entity](/integrations/update). Furthermore, the CSA DCL (Distributed Compliance Ledger) stores firmware update information. Home Assistant reads firmware update information directly from the DCL to learn about available updates. By default, the integration checks every 12 hours for an update. If you want to force an update check, use the `homeassistant.update_entity` [action](/integrations/homeassistant/) with the update entity as the target. | |
| The Matter protocol supports OTA (Over-the-Air) software updates. But the OTA software update is an optional feature for Matter devices, so not all Matter devices implement it. Home Assistant creates an update entity for every Matter device which does support Matter updates. | |
| The CSA operates a Distributed Compliance Ledger (DCL) which provides metadata for firmware updates. By default, the Matter update entities check the DCL every 12 hours for updates. If you want to force an update check, use the `homeassistant.update_entity` [action](/integrations/homeassistant/), with the update entity as the target. Currently, Eve and Nanoleaf are using the DCL to provide updates. It is expected that in future, more and more firmware updates become available through the DCL. | |
| <p class='img'> | |
| <img src='/images/integrations/matter/matter_ota_message.png' alt='Matter device OTA update message'> | |
| Notification of an OTA update for a Matter device | |
| </p> | |
| ## Matter OTA device updates | |
| The Matter protocol supports OTA (Over-the-Air) software updates. But the OTA software update is an optional feature for Matter devices, so not all Matter devices implement it. Home Assistant creates an update entity for every Matter device which does support Matter updates. | |
| The CSA operates a Distributed Compliance Ledger (DCL) which provides metadata for firmware updates. By default, the Matter update entities check the DCL every 12 hours for updates. If you want to force an update check, use the `homeassistant.update_entity` [action](/integrations/homeassistant/), with the update entity as the target. Currently, Eve and Nanoleaf are using the DCL to provide updates. It is expected that in the future, more and more firmware updates become available through the DCL. | |
| <p class='img'> | |
| <img src='/images/integrations/matter/matter_ota_message.png' alt='Matter device OTA update message'> | |
| Notification of an OTA update for a Matter device | |
| </p> |
Tools
LanguageTool
[locale-violation] ~329-~329: The phrase ‘in future’ is British English. Did you mean: “in the future”?
Context: ...to provide updates. It is expected that in future, more and more firmware updates become ...(IN_FUTURE)
|
|
||
| ```text | ||
| https://github.com/home-assistant/operating-system/releases/download/{{site.data.version_data.hassos[variant.key]}}/haos_{{ variant.key }}-{{site.data.version_data.hassos[variant.key]}}.img.xz | ||
| ``` |
There was a problem hiding this comment.
Remove trailing spaces for markdown compliance.
Trailing spaces in the URL section should be removed to adhere to markdown standards.
- ```
+ ```Tools
Markdownlint
90-90: Expected: 0 or 2; Actual: 4
Trailing spaces(MD009, no-trailing-spaces)
| - [Patch releases](#patch-releases) | ||
| - [2024.8.1 - August 10](#202481---august-10) | ||
| - [2024.8.2 - August 16](#202482---august-16) |
There was a problem hiding this comment.
Add commas for date formatting.
Add commas to separate the day and year in the date format for consistency.
- 2024.8.1 - August 10
+ 2024.8.1 - August 10,
- 2024.8.2 - August 16
+ 2024.8.2 - August 16,Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - [Patch releases](#patch-releases) | |
| - [2024.8.1 - August 10](#202481---august-10) | |
| - [2024.8.2 - August 16](#202482---august-16) | |
| - [Patch releases](#patch-releases) | |
| - [2024.8.1 - August 10,](#202481---august-10) | |
| - [2024.8.2 - August 16,](#202482---august-16) |
Tools
LanguageTool
[uncategorized] ~62-~62: Commas set off the year in a month-day-year date.
Context: ...eases](#patch-releases) - 2024.8.1 - August 10 - [2024.8.2 - A...(MISSING_COMMA_BETWEEN_DAY_AND_YEAR)
| - Fix error message in html5 ([@mib1185] - [#123749]) | ||
| - Bump py-nextbusnext to 2.0.4 ([@ViViDboarder] - [#123750]) | ||
| - Bump python-nest-sdm to 4.0.6 ([@allenporter] - [#123762]) | ||
| - Update xknx to 3.1.0 and fix climate read only mode ([@farmio] - [#123776]) |
There was a problem hiding this comment.
Use a hyphen for compound adjectives.
The term "read only" should be hyphenated to "read-only" when used as an adjective.
- fix climate read only mode
+ fix climate read-only modeCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Update xknx to 3.1.0 and fix climate read only mode ([@farmio] - [#123776]) | |
| - Update xknx to 3.1.0 and fix climate read-only mode ([@farmio] - [#123776]) |
Tools
LanguageTool
[uncategorized] ~729-~729: The adjective “read-only” is spelled with a hyphen.
Context: ... - Update xknx to 3.1.0 and fix climate read only mode ([@farmio] - [#123776]) - Fix KNX ...(READ_ONLY_ACCESS_HYPHEN)
| [#122479]: https://github.com/home-assistant/core/pull/122479 | ||
| [#123276]: https://github.com/home-assistant/core/pull/123276 | ||
| [#123454]: https://github.com/home-assistant/core/pull/123454 | ||
| [#123544]: https://github.com/home-assistant/core/pull/123544 |
There was a problem hiding this comment.
Remove unused link reference definition: "#123544".
The link reference definition is not used in the document and should be removed to avoid confusion.
- [#123544]: https://github.com/home-assistant/core/pull/123544Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [#123544]: https://github.com/home-assistant/core/pull/123544 |
Tools
Markdownlint
1300-1300: Unused link or image reference definition: "#123544"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
| [@edenhaus]: https://github.com/edenhaus | ||
| [@emontnemery]: https://github.com/emontnemery | ||
| [@farmio]: https://github.com/farmio | ||
| [@frenck]: https://github.com/frenck |
There was a problem hiding this comment.
Remove duplicate link reference definition: "@frenck".
The link reference definition is duplicated and should be removed to avoid redundancy.
- [@frenck]: https://github.com/frenckCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [@frenck]: https://github.com/frenck |
Tools
Markdownlint
1359-1359: Duplicate link or image reference definition: "@frenck"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
| [@joostlek]: https://github.com/joostlek | ||
| [@kingy444]: https://github.com/kingy444 | ||
| [@miaucl]: https://github.com/miaucl | ||
| [@mib1185]: https://github.com/mib1185 |
There was a problem hiding this comment.
Remove duplicate link reference definition: "@mib1185".
The link reference definition is duplicated and should be removed to avoid redundancy.
- [@mib1185]: https://github.com/mib1185Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [@mib1185]: https://github.com/mib1185 |
Tools
Markdownlint
1366-1366: Duplicate link or image reference definition: "@mib1185"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
| [@alengwenus]: https://github.com/alengwenus | ||
| [@allenporter]: https://github.com/allenporter | ||
| [@autinerd]: https://github.com/autinerd | ||
| [@bdraco]: https://github.com/bdraco |
There was a problem hiding this comment.
Remove duplicate link reference definition: "@bdraco".
The link reference definition is duplicated and should be removed to avoid redundancy.
- [@bdraco]: https://github.com/bdracoCommittable suggestion was skipped due to low confidence.
Tools
Markdownlint
1352-1352: Duplicate link or image reference definition: "@bdraco"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
|
|
||
| [#114628]: https://github.com/home-assistant/core/pull/114628 | ||
| [#122479]: https://github.com/home-assistant/core/pull/122479 | ||
| [#123276]: https://github.com/home-assistant/core/pull/123276 |
There was a problem hiding this comment.
Remove duplicate link reference definition: "#123276".
The link reference definition is duplicated and should be removed to avoid redundancy.
- [#123276]: https://github.com/home-assistant/core/pull/123276Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [#123276]: https://github.com/home-assistant/core/pull/123276 |
Tools
Markdownlint
1298-1298: Duplicate link or image reference definition: "#123276"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
| [#124027]: https://github.com/home-assistant/core/pull/124027 | ||
| [#124041]: https://github.com/home-assistant/core/pull/124041 | ||
| [#124047]: https://github.com/home-assistant/core/pull/124047 | ||
| [@Bre77]: https://github.com/Bre77 |
There was a problem hiding this comment.
Remove duplicate link reference definition: "@Bre77".
The link reference definition is duplicated and should be removed to avoid redundancy.
- [@Bre77]: https://github.com/Bre77Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| [@Bre77]: https://github.com/Bre77 |
Tools
Markdownlint
1343-1343: Duplicate link or image reference definition: "@Bre77"
Link and image reference definitions should be needed(MD053, link-image-reference-definitions)
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
jbouwh
removed request for
a team,
fabaff,
frenck,
bieniu,
Danielhiversen,
bdraco,
dmulcahey,
balloob,
thecode,
synesthesiam,
jpbede,
Adminiuga,
TheJulianJES,
tronikos,
emontnemery,
starkillerOG,
klaasnicolaas,
puddly,
chemelli74 and
gjohansson-ST
Sorry about that! I'll re-open it shortly Fixed: #34352 |
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
ruby-lspgem for improved performance and minor feature enhancements.redditorsfor Reddit integrations to specify user data collection.Bug Fixes
Documentation
Chores