Skip to content
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.

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

Update recorder.markdown #34969

Merged
merged 1 commit into from
Sep 30, 2024
Merged

Update recorder.markdown #34969

merged 1 commit into from
Sep 30, 2024

Conversation

tomlut
Copy link
Contributor

@tomlut tomlut commented Sep 29, 2024

Proposed change

Removed reference to history filtering. This no longer exists.

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
    • Updated terminology in the recorder integration documentation for clarity, changing "hide events from your history" to "hide events from your logbook."

Removed reference to history filtering. This no longer exists.
@tomlut tomlut requested a review from a team as a code owner September 29, 2024 21:07
@home-assistant home-assistant bot added the current This PR goes into the current branch label Sep 29, 2024
Copy link
Contributor

coderabbitai bot commented Sep 29, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a minor textual modification in the documentation for the recorder integration. The phrase "hide events from your history" has been changed to "hide events from your logbook," providing clearer guidance on the functionality related to the logbook integration. There are no changes to the functionality or declarations of exported or public entities.

Changes

File Change Summary
source/_integrations/recorder.markdown Updated phrase from "hide events from your history" to "hide events from your logbook."

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    User->>System: Request to hide events
    System-->>User: Confirm events are hidden from logbook
Loading

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 3ad4024 and 8fdd210.

📒 Files selected for processing (1)
  • source/_integrations/recorder.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/recorder.markdown

[grammar] ~152-~152: Use “nor” with neither.
Context: ...nts or want them in neither the history or logbook, you should use the exclude/`...

(NEITHER_NOR)


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

Copy link

netlify bot commented Sep 29, 2024

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 8fdd210
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/66f9c1a18410e80008fca45e
😎 Deploy Preview https://deploy-preview-34969--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.

Copy link
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, @tomlut 👍

../Frenck

@frenck frenck merged commit e6e7431 into home-assistant:current Sep 30, 2024
6 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Oct 1, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants