Skip to content

feat: update madvr docs#33659

Merged
frenck merged 4 commits into
home-assistant:nextfrom
iloveicedgreentea:madvrdocs_binar
Jul 10, 2024
Merged

feat: update madvr docs#33659
frenck merged 4 commits into
home-assistant:nextfrom
iloveicedgreentea:madvrdocs_binar

Conversation

@iloveicedgreentea
Copy link
Copy Markdown
Contributor

@iloveicedgreentea iloveicedgreentea commented Jul 9, 2024 •
edited
Loading

Proposed change

Updated docs to reflect new entity names

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

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

  • Refactor
    • Renamed binary sensors in the madvr integration from uppercase to lowercase for consistency and clarity. Sensors affected include power state, signal state, HDR flag, and outgoing HDR flag.

@home-assistant home-assistant Bot added has-parent This PR has a parent PR in another repo next This PR goes into the next branch labels Jul 9, 2024
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jul 9, 2024 •
edited
Loading

Walkthrough

Walkthrough

The changes are focused on renaming binary sensors within the madvr integration in Home Assistant. This renaming effort aims to standardize the names of sensors related to power state, signal state, HDR flag, and outgoing HDR flag. The primary goal is to enhance consistency and readability by aligning sensor names with lowercase naming conventions.

Changes

File Change Summary
source/_integrations/madvr.markdown Renamed binary sensors for improved consistency and clarity: Power State to Power state, Signal State to Signal state, HDR Flag to HDR flag, and Outgoing HDR Flag to Outgoing HDR flag.

Sequence Diagram(s)

Not applicable for this change.

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?

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>.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @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.

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)

  • @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 resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@netlify
Copy link
Copy Markdown

netlify Bot commented Jul 9, 2024 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 9344678
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/668d7eb242961a0008cdeb4b
😎 Deploy Preview https://deploy-preview-33659--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 site configuration.

@iloveicedgreentea iloveicedgreentea mentioned this pull request Jul 9, 2024
Merged
19 tasks
coderabbitai[bot]
coderabbitai Bot reviewed Jul 9, 2024
View reviewed changes
Copy link
Copy Markdown
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: 2

Comment thread source/_integrations/madvr.markdown Outdated
Comment thread source/_integrations/madvr.markdown Outdated
@joostlek joostlek added the parent-merged The parent PR has been merged already label Jul 9, 2024
coderabbitai[bot]
coderabbitai Bot reviewed Jul 9, 2024
View reviewed changes
Copy link
Copy Markdown
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: 4

Comment thread source/_integrations/madvr.markdown Outdated
Comment thread source/_integrations/madvr.markdown Outdated
Comment thread source/_integrations/madvr.markdown Outdated
Comment thread source/_integrations/madvr.markdown Outdated
@iloveicedgreentea iloveicedgreentea mentioned this pull request Jul 9, 2024
Merged
19 tasks
frenck
frenck requested changes Jul 9, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

This PR, now has once again, multiple parent PR linked.

Just like the preview review / PRs. That is now allowed.

../Frenck

@home-assistant
Copy link
Copy Markdown

home-assistant Bot commented Jul 9, 2024

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@home-assistant home-assistant Bot marked this pull request as draft July 9, 2024 18:19
@iloveicedgreentea
Copy link
Copy Markdown
Contributor Author

iloveicedgreentea commented Jul 9, 2024

I corrected the linked PR, it should follow the sensor one

@iloveicedgreentea iloveicedgreentea marked this pull request as ready for review July 9, 2024 20:32
@home-assistant home-assistant Bot requested a review from frenck July 9, 2024 20:32
@frenck
Copy link
Copy Markdown
Member

frenck commented Jul 9, 2024

I corrected the linked PR, it should follow the sensor one

So where is the PR of the binary sensor one then?

@frenck frenck marked this pull request as draft July 9, 2024 20:40
@iloveicedgreentea
Copy link
Copy Markdown
Contributor Author

iloveicedgreentea commented Jul 9, 2024

I corrected the linked PR, it should follow the sensor one

So where is the PR of the binary sensor one then?

I mistakenly included that in the first pr #33626

@frenck frenck marked this pull request as ready for review July 10, 2024 21:54
frenck
frenck approved these changes Jul 10, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @iloveicedgreentea 👍

../Frenck

@frenck frenck merged commit 7443e5a into home-assistant:next Jul 10, 2024
@home-assistant home-assistant Bot removed the parent-merged The parent PR has been merged already label Jul 10, 2024
@github-actions github-actions Bot locked and limited conversation to collaborators Jul 11, 2024
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

@frenck frenck frenck approved these changes

Assignees

No one assigned

Labels

has-parent This PR has a parent PR in another repo next This PR goes into the next branch

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@iloveicedgreentea @frenck @joostlek