Skip to content

Clean up non working example from Edimax integration docs #38557

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
Apr 16, 2025
Merged

Clean up non working example from Edimax integration docs #38557

merged 1 commit into from
Apr 16, 2025

Conversation

frenck
Copy link
Member

@frenck frenck commented Apr 15, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Addresses feedback from: #35226

The power/energy sensors have been removed here: home-assistant/core#68821

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

  • Documentation
    • Updated the introductory sentence for the Edimax integration.
    • Removed the section detailing how to create template sensors for power consumption and daily energy, including example YAML and related notes.

@home-assistant home-assistant bot added current This PR goes into the current branch has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 15, 2025
@home-assistant

This comment was marked as resolved.

Sign in to view
@netlify Netlify
Copy link

netlify bot commented Apr 15, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit a1ad937
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67fec0097f4e020008676972
😎 Deploy Preview https://deploy-preview-38557--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.

@frenck frenck removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on has-parent This PR has a parent PR in a other repo labels Apr 15, 2025
@frenck frenck requested a review from Copilot April 15, 2025 20:23
Copilot
Copilot AI reviewed Apr 15, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo in-progress This PR/Issue is currently being worked on needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch labels Apr 15, 2025
@home-assistant
Copy link

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 next branch. Please change the target branch of this PR to next and rebase if needed.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 15, 2025

📝 Walkthrough

Walkthrough

The documentation for the Edimax integration was updated by revising the introductory sentence to remove specific formatting and references to "switch." Additionally, a detailed section explaining how to create template sensors for monitoring power consumption and energy usage, including example YAML code and explanatory notes, was removed from the documentation. No changes were made to any code or configuration files, and no public entities were altered.

Changes

File(s) Change Summary
source/_integrations/edimax.markdown Updated introductory sentence for clarity; removed section on creating template sensors for power and energy monitoring, including example YAML and related notes.

Sequence Diagram(s)

No sequence diagram is generated as the changes are limited to documentation updates without any impact on control flow or feature logic.

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.
📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a6f946c and a1ad937.

📒 Files selected for processing (1)
  • source/_integrations/edimax.markdown (1 hunks)
🔇 Additional comments (2)
source/_integrations/edimax.markdown (2)

18-18: Introductory sentence update is accurate and appropriate.

The change from "edimax switch integration" to "Edimax integration" improves clarity and reflects the current integration scope. No issues found.

19-51: Removal of template sensor documentation is correct and necessary.

The section describing template sensors for power and energy monitoring has been correctly removed, as these attributes are no longer provided by the integration. This prevents user confusion and ensures the documentation matches the integration's current capabilities.

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.
    • 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 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 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 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 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.

c0ffeeca7
c0ffeeca7 approved these changes Apr 16, 2025
View reviewed changes
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Thank you, @frenck 👍

@c0ffeeca7 c0ffeeca7 merged commit b616aa6 into current Apr 16, 2025
9 checks passed
@c0ffeeca7 c0ffeeca7 deleted the frenck-2025-0176 branch April 16, 2025 06:17
@home-assistant home-assistant bot removed needs-rebase The PR has been branched of the wrong base branch or targets an incorrect target branch in-progress This PR/Issue is currently being worked on labels Apr 16, 2025
@github-actions github-actions bot locked and limited conversation to collaborators Apr 17, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

Copilot code review Copilot Copilot left review comments

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees

@frenck frenck

Labels
current This PR goes into the current branch has-parent This PR has a parent PR in a other repo
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Edimax example for energy usage is no longer valid
2 participants
@frenck @c0ffeeca7