Cleanup mqtt publish action template option documentation #34257
Conversation
home-assistant
bot
added
current
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
jbouwh
added
integration: mqtt
and removed
needs-rebase
|
Hey there @emontnemery, @bdraco, mind taking a look at this feedback as it has been labeled with an integration ( Code owner commandsCode owners of
|
WalkthroughWalkthroughThe changes to the MQTT integration documentation focus on the Changes
Assessment against linked issues
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 (
|
home-assistant
bot
added
in-progress
|
It seems that this PR is targeted against an incorrect branch since it has a parent PR on one of our codebases. Documentation that needs to be updated for an upcoming release should target the |
![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
Outside diff range, codebase verification and nitpick comments (2)
source/_integrations/mqtt.markdown (2)
Line range hint
1113-1132:
Clarify the use ofpayloadandpayload_template.The examples provided for
mqtt.publishare helpful, but they should explicitly mention the constraints regarding the use ofpayloadandpayload_template. Users should be aware that both cannot be used simultaneously.Consider adding a note to emphasize this constraint to prevent potential misuse.
Tools
LanguageTool
[typographical] ~1139-~1139: Consider adding a comma.
Context: ... want to send JSON using the YAML editor then you need to format/escape it properly. ...(IF_THEN_COMMA)
Line range hint
1149-1167:
Ensure consistency in example formatting.The example provided for publishing a temperature sensor is well-structured. Ensure that similar examples throughout the documentation maintain consistent formatting and detail level.
No changes needed here, but keep this consistency in mind for future documentation updates.
Tools
LanguageTool
[typographical] ~1139-~1139: Consider adding a comma.
Context: ... want to send JSON using the YAML editor then you need to format/escape it properly. ...(IF_THEN_COMMA)
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
source/_integrations/mqtt.markdown (1)
1138-1142: Clarification on payload format is helpful.The note that
payloadmust be a string and the guidance on JSON formatting are crucial for user understanding.Consider adding a comma for clarity.
A comma after "YAML editor" would improve readability.
- If you want to send JSON using the YAML editor then you need to format/escape + If you want to send JSON using the YAML editor, then you need to format/escapeTools
LanguageTool
[typographical] ~1139-~1139: Consider adding a comma.
Context: ... want to send JSON using the YAML editor then you need to format/escape it properly. ...(IF_THEN_COMMA)
c0ffeeca7
removed
in-progress
…tant#34257) * Cleanup mqtt publish action template option documentation * Missed instance
Proposed change
Cleanup mqtt publish action template option documentation.
This is a follow up on #33854
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
topicandpayloadparameters.payloadmust be a string and included guidance on JSON formatting in YAML.