Skip to content

Add 3 stars to description #38639

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

Merged
merged 1 commit into from
Apr 22, 2025
Merged

Conversation

tsvi
Copy link
Contributor

@tsvi tsvi commented Apr 20, 2025

Proposed change

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 Documentation out of date? #38127

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
    • Added information about a new time sensor for "3 stars visible" (t_set_hakochavim_3_stars) to the Jewish Calendar integration documentation. This sensor indicates the time when three stars are visible, commonly used for Havdalah.

@home-assistant home-assistant bot added the current This PR goes into the current branch label Apr 20, 2025
Copy link

netlify bot commented Apr 20, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit 20da8c2
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6804ce9d81a23f0008c8f18a
😎 Deploy Preview https://deploy-preview-38639--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
Contributor

coderabbitai bot commented Apr 20, 2025

📝 Walkthrough

Walkthrough

A new time sensor, t_set_hakochavim_3_stars, has been added to the Jewish Calendar integration documentation. This sensor indicates the time when three stars are visible, which is significant for Havdalah. The documentation update expands the list of available time-based sensors without modifying existing entries or their descriptions.

Changes

File(s) Change Summary
source/_integrations/jewish_calendar.markdown Added documentation for the new time sensor t_set_hakochavim_3_stars, describing its purpose and usage in the Jewish Calendar integration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant JewishCalendarIntegration
    User->>JewishCalendarIntegration: Request list of available time sensors
    JewishCalendarIntegration-->>User: Return sensors including t_set_hakochavim_3_stars
Loading

Assessment against linked issues

Objective Addressed Explanation
Update documentation to reflect the current list of available sensors (including new ones) (#38127)
Ensure documentation matches entities visible in the integration listing (#38127)

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.

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.

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 (1)
source/_integrations/jewish_calendar.markdown (1)

73-75: Add Hebrew transliteration and translation for the new sensor for consistency.
Most existing time sensors include both the romanized name and the Hebrew term in parentheses (e.g., (Tseit Hakochavim – צאת הכוכבים)). Consider updating the new entry to:

- - `t_set_hakochavim_3_stars`: Time at which 3 stars are visible, mostly used for Havdalah
+ - `t_set_hakochavim_3_stars`: Time at which three stars are visible (Tseit HaKochavim Meshalosh – צאת הכוכבים שלוש), mostly used for Havdalah

This will keep the style consistent across the sensor list.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between c51b56e and 20da8c2.

📒 Files selected for processing (1)
  • source/_integrations/jewish_calendar.markdown (1 hunks)
⏰ 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

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, @tsvi 👍

@c0ffeeca7 c0ffeeca7 merged commit ce05f0b into home-assistant:current Apr 22, 2025
7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Apr 23, 2025
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.

Documentation out of date?
2 participants