Skip to content

Fix more incorrect MQTT device discovery abbreviations for cmps #39762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 1 commit into from
Jun 29, 2025
Merged

Fix more incorrect MQTT device discovery abbreviations for cmps #39762

merged 1 commit into from
Jun 29, 2025

Conversation

jbouwh
Copy link
Contributor

@jbouwh jbouwh commented Jun 29, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Follow up on #39757
Fix more incorrect MQTT device discovery abbreviations for cmps

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

  • Link to parent pull request in the codebase:
  • Link to parent pull request in the Brands repository:
  • This PR fixes or closes issue: fixes #

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Corrected the abbreviation for the components key in MQTT device discovery documentation to consistently use "cmps" instead of "cmp" or "components".
    • Updated descriptions and migration examples to reflect the correct abbreviation.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Jun 29, 2025
@netlify Netlify
Copy link

netlify bot commented Jun 29, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 0767f14
🔍 Latest deploy log https://app.netlify.com/projects/home-assistant-docs/deploys/6861219ca5f86500086fea85
😎 Deploy Preview https://deploy-preview-39762--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@home-assistant
Copy link

Hey there @emontnemery, @bdraco, mind taking a look at this feedback as it has been labeled with an integration (mqtt) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of mqtt can trigger bot actions by commenting:

  • @home-assistant close Closes the feedback.
  • @home-assistant rename Awesome new title Renames the feedback.
  • @home-assistant reopen Reopen the feedback.
  • @home-assistant unassign mqtt Removes the current integration label and assignees on the feedback, add the integration domain after the command.
  • @home-assistant add-label needs-more-information Add a label (needs-more-information) to the feedback.
  • @home-assistant remove-label needs-more-information Remove a label (needs-more-information) on the feedback.

@jbouwh jbouwh mentioned this pull request Jun 29, 2025
Merged
8 tasks
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Jun 29, 2025

📝 Walkthrough

Walkthrough

The documentation for MQTT device discovery was updated to consistently use the correct abbreviation cmps for the components key, replacing previous references to cmp. These edits affect descriptive text and migration examples, ensuring alignment with the actual JSON payloads and supported abbreviations. No functional or logic changes were made.

Changes

File Change Summary
source/_integrations/mqtt.markdown Updated documentation to use cmps instead of cmp for components key in descriptions and examples.

Sequence Diagram(s)

No sequence diagram generated as the changes are limited to documentation updates.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot]
coderabbitai bot reviewed Jun 29, 2025
View reviewed changes
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
source/_integrations/mqtt.markdown (2)

410-414: Consider tightening the wording & fix the pluralisation

components id's mixes pluralisation with possessive 's and reads awkwardly.
Re-phrase to something like “The component IDs under the components (cmps) key are used …” for better grammar and clarity.

-The components id's under the `components` (`cmps`) key, are used ...
+The component IDs under the `components` (`cmps`) key are used ...

571-573: Add missing space after the back-ticked text

There is no space between `0AFFD2` and “from”, making the sentence hard to read.

-Discovery id: `0AFFD2 bla` *(`0AFFD2`from discovery topic, `bla`: The key under `cmps` in the discovery payload)*
+Discovery id: `0AFFD2 bla` *(`0AFFD2` from the discovery topic, `bla`: the key under `cmps` in the discovery payload)*
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between a40b921 and 0767f14.

📒 Files selected for processing (1)
  • source/_integrations/mqtt.markdown (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`source/_integrations/*`: Integration documentation must use the provided template structure and section order.

source/_integrations/*: Integration documentation must use the provided template structure and section order.

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

  • source/_integrations/mqtt.markdown
⏰ 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

@silamon silamon merged commit 2cd03b9 into current Jun 29, 2025
9 checks passed
@silamon silamon deleted the mqtt-cmps branch June 29, 2025 11:37
@github-actions github-actions bot locked and limited conversation to collaborators Jun 30, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@silamon silamon silamon approved these changes

@emontnemery emontnemery Awaiting requested review from emontnemery emontnemery is a code owner

@bdraco bdraco Awaiting requested review from bdraco bdraco is a code owner

Assignees

@bdraco bdraco

@emontnemery emontnemery

Labels
by-code-owner current This PR goes into the current branch integration: mqtt
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@jbouwh @silamon @bdraco @emontnemery