Update Jewish calendar omer counting service documentation #38706
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe documentation for the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant JewishCalendarIntegration
User->>JewishCalendarIntegration: Call count_omer (nusach, [date], [language], [after_sunset])
alt after_sunset is true and date provided
JewishCalendarIntegration->>JewishCalendarIntegration: Calculate Omer for next day after date
else after_sunset not provided or date not provided
JewishCalendarIntegration->>JewishCalendarIntegration: Calculate Omer for date (default: today)
end
JewishCalendarIntegration-->>User: Return Omer count text (in specified/default language)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (3)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/jewish_calendar.markdown (4)
153-153: Replace hard tabs and clarify default fordate
The table row fordatecontains hard tabs and the description reads "Defaults today". Please replace the tab characters with spaces and update the text to "Defaults to today."🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
153-153: Hard tabs
Column: 23(MD010, no-hard-tabs)
153-153: Hard tabs
Column: 82(MD010, no-hard-tabs)
154-154: Refine and reformat description foris_after_sunset
This new attribute line uses hard tabs and the wording could be clearer. Replace tabs with spaces and rephrase to something like:
"If true and a date is provided, calculates the Omer count for the next day. Ignored if no date is specified."🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
154-154: Hard tabs
Column: 25(MD010, no-hard-tabs)
156-156: Replace hard tabs and clarify default forlanguage
Thelanguagerow also uses a hard tab. Please switch to spaces and specify the default clearly, for example: "Defaults tohebrew."🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
156-156: Hard tabs
Column: 23(MD010, no-hard-tabs)
180-186: Revise minimal example formatting and fix grammar
The "Minimal call" section has double spaces, lacks a heading level, and the fenced block isn’t surrounded by blank lines. Also, improve the sentence to include "the". Suggested diff:- Minimal call - ```yaml - action: jewish_calendar.count_omer - data: - nusach: sfarad - ``` - Will return the current text in Hebrew based on current Hebrew date (before/after sunset) + #### Minimal call + + ```yaml + action: jewish_calendar.count_omer + data: + nusach: sfarad + ``` + + Will return the current text in Hebrew based on the current Hebrew date (before/after sunset).🧰 Tools
🪛 LanguageTool
[uncategorized] ~186-~186: You might be missing the article “the” here.
Context: ...urn the current text in Hebrew based on current Hebrew date (before/after sunset)(AI_EN_LECTOR_MISSING_DETERMINER_THE)
🪛 markdownlint-cli2 (0.17.2)
181-181: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
185-185: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/jewish_calendar.markdown(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/jewish_calendar.markdown
153-153: Hard tabs
Column: 23
(MD010, no-hard-tabs)
153-153: Hard tabs
Column: 82
(MD010, no-hard-tabs)
154-154: Hard tabs
Column: 25
(MD010, no-hard-tabs)
156-156: Hard tabs
Column: 23
(MD010, no-hard-tabs)
181-181: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
185-185: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
🪛 LanguageTool
source/_integrations/jewish_calendar.markdown
[uncategorized] ~186-~186: You might be missing the article “the” here.
Context: ...urn the current text in Hebrew based on current Hebrew date (before/after sunset)
(AI_EN_LECTOR_MISSING_DETERMINER_THE)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
- GitHub Check: Lint Markdown
- GitHub Check: Lint Text
🔇 Additional comments (1)
source/_integrations/jewish_calendar.markdown (1)
168-168: Addingis_after_sunsetto the main example is correct
The example now properly includesis_after_sunset: true, reflecting the updated action signature.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/jewish_calendar.markdown (2)
153-154: Enhance table descriptions for clarity and consistency
- Rephrase descriptions to use proper grammar and punctuation: e.g., change “Defaults today” → “Defaults to today.”
- Capitalize sentence beginnings and ensure each description ends with a period.
- Confirm consistent casing for “yes”/“no” values per Home Assistant style guide.
Proposed diff:
| `date` | yes | Date for which to get the Omer blessing. Defaults to today. | | `is_after_sunset`| yes | If true and a date is provided, calculates the Omer count for the next day. Ignored if no date is specified. |
180-187: Fix heading spacing and surround code block with blank lines
- Remove the extra space in the heading: change
#### Minimal call→#### Minimal call.- Add a blank line before and after the fenced code block to satisfy MD022 and MD031.
Proposed diff:
-#### Minimal call - -```yaml -action: jewish_calendar.count_omer -data: - nusach: sfarad -``` -Will return the current text in Hebrew based on current Hebrew date (before/after sunset) +#### Minimal call + +```yaml +action: jewish_calendar.count_omer +data: + nusach: sfarad +``` + +Will return the current text in Hebrew based on current Hebrew date (before/after sunset)🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
180-180: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above(MD022, blanks-around-headings)
180-180: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below(MD022, blanks-around-headings)
181-181: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
185-185: Fenced code blocks should be surrounded by blank lines
null(MD031, blanks-around-fences)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/jewish_calendar.markdown(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/jewish_calendar.markdown
180-180: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Above
(MD022, blanks-around-headings)
180-180: Headings should be surrounded by blank lines
Expected: 1; Actual: 0; Below
(MD022, blanks-around-headings)
181-181: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
185-185: Fenced code blocks should be surrounded by blank lines
null
(MD031, blanks-around-fences)
⏰ 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
🔇 Additional comments (1)
source/_integrations/jewish_calendar.markdown (1)
168-168: Example updated correctly with new attributeThe primary YAML example now includes
is_after_sunset: true, which clearly demonstrates the new optional attribute.
Co-authored-by: Tsvi Mostovicz <ttmost@gmail.com>
Co-authored-by: Tsvi Mostovicz <ttmost@gmail.com>
Co-authored-by: Tsvi Mostovicz <ttmost@gmail.com>
Co-authored-by: Tsvi Mostovicz <ttmost@gmail.com>
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
source/_integrations/jewish_calendar.markdown (1)
180-186: Refine minimal call section formatting and wording
- Surround the heading and fenced blocks with blank lines to satisfy lint rules (MD022, MD031).
- Simplify wording: replace “taking into consideration” with “considering”.
Proposed diff:
-#### Minimal call + +#### Minimal call + ```yaml action: jewish_calendar.count_omer data: nusach: sfarad
Will return the current text in Hebrew based on the current Hebrew date (considering the current time w.r.t. sunset)
<details> <summary>🧰 Tools</summary> <details> <summary>🪛 LanguageTool</summary> [style] ~186-~186: The phrase “taking into consideration” may be wordy. To make your writing clearer, consider replacing it. Context: ...ebrew based on the current Hebrew date (taking into consideration the current time w.r.t. sunset) (TAKE_INTO_CONSIDERATION) </details> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> 180-180: Headings should be surrounded by blank lines Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) --- 180-180: Headings should be surrounded by blank lines Expected: 1; Actual: 0; Below (MD022, blanks-around-headings) --- 181-181: Fenced code blocks should be surrounded by blank lines null (MD031, blanks-around-fences) --- 185-185: Fenced code blocks should be surrounded by blank lines null (MD031, blanks-around-fences) </details> </details> </blockquote></details> </blockquote></details> <details> <summary>📜 Review details</summary> **Configuration used: CodeRabbit UI** **Review profile: CHILL** **Plan: Pro** <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between be0827b38d22aa76e2e2716fc9625a69420c7683 and 5cbbd10a163d943b9d0fbc9530ea2bb8ab3e9828. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `source/_integrations/jewish_calendar.markdown` (3 hunks) </details> <details> <summary>🧰 Additional context used</summary> <details> <summary>🪛 LanguageTool</summary> <details> <summary>source/_integrations/jewish_calendar.markdown</summary> [style] ~186-~186: The phrase “taking into consideration” may be wordy. To make your writing clearer, consider replacing it. Context: ...ebrew based on the current Hebrew date (taking into consideration the current time w.r.t. sunset) (TAKE_INTO_CONSIDERATION) </details> </details> <details> <summary>🪛 markdownlint-cli2 (0.17.2)</summary> <details> <summary>source/_integrations/jewish_calendar.markdown</summary> 180-180: Headings should be surrounded by blank lines Expected: 1; Actual: 0; Above (MD022, blanks-around-headings) --- 180-180: Headings should be surrounded by blank lines Expected: 1; Actual: 0; Below (MD022, blanks-around-headings) --- 181-181: Fenced code blocks should be surrounded by blank lines null (MD031, blanks-around-fences) --- 185-185: Fenced code blocks should be surrounded by blank lines null (MD031, blanks-around-fences) </details> </details> </details> <details> <summary>⏰ Context from checks skipped due to timeout of 90000ms (3)</summary> * GitHub Check: Redirect rules - home-assistant-docs * GitHub Check: Header rules - home-assistant-docs * GitHub Check: Pages changed - home-assistant-docs </details> <details> <summary>🔇 Additional comments (1)</summary><blockquote> <details> <summary>source/_integrations/jewish_calendar.markdown (1)</summary> `168-168`: **Example usage correctly includes `after_sunset`** The new `after_sunset: true` line aligns with the updated API. No further changes needed here. </details> </blockquote></details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Co-authored-by: Tsvi Mostovicz <ttmost@gmail.com>
Co-authored-by: Tsvi Mostovicz <ttmost@gmail.com>
| ``` | ||
| Will return the current text in Hebrew based on the current Hebrew date (taking into consideration the current time w.r.t. sunset) |
There was a problem hiding this comment.
I didn't mean to delete this, I only wanted to add a whitespace between ``` and the text.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/jewish_calendar.markdown (1)
153-156: Ensure consistent table formatting and default notationThe
after_sunsetrow should end with a period and use lowercasetrueto match YAML conventions. Also add a comma after “Hebrew date” for clarity and normalize spacing around the pipe separators:-| `after_sunset` | yes | If true and a date is provided, calculates the Omer count based on the Hebrew date which starts after sunset. Ignored if no date is specified. Defaults to True | +| `after_sunset` | yes | If true and a date is provided, calculates the Omer count based on the Hebrew date, which starts after sunset. Ignored if no date is specified. Defaults to true. |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/jewish_calendar.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/jewish_calendar.markdown
[style] ~189-~189: The phrase “taking into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...ebrew based on the current Hebrew date (taking into consideration the current time w.r.t. sunset)
(TAKE_INTO_CONSIDERATION)
🔇 Additional comments (2)
source/_integrations/jewish_calendar.markdown (2)
168-168: Great addition ofafter_sunsetin the exampleIncluding
after_sunset: truein the full example helps users see how to opt into post-sunset calculations.
183-187: Minimal call snippet added correctlyThis minimal example correctly shows invoking the action with only the required
nusachparameter, implicitly using the documented defaults (date=today,language=Hebrew,after_sunset=true).
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/jewish_calendar.markdown (2)
168-168: Consider reordering keys in the full example
In the full-example snippet you list all four attributes. To improve readability, group the required key first (nusach) and then the optional keys in a logical order (e.g.,date,language,after_sunset). This makes it clearer which fields users truly must supply.Example diff:
data: nusach: sfarad - language: en - after_sunset: true - date: "2025-05-20" + date: "2025-05-20" # optional; defaults to today + language: en # optional; defaults to Hebrew + after_sunset: true # optional; defaults to true
180-189: Enhance the minimal call section with a sample response and tighten phrasing
The minimal-call example shows only the request but no output. For consistency with the full example, add a YAML snippet illustrating the expected response (e.g.,message,weeks,days,total_days).
Additionally, the phrase “taking into consideration the current time w.r.t. sunset” can be simplified for clarity. For example:- Will return the current text in Hebrew based on the current Hebrew date (taking into consideration the current time w.r.t. sunset) + Will return the current text in Hebrew based on the Hebrew date, considering the current time relative to sunset.🧰 Tools
🪛 LanguageTool
[style] ~189-~189: The phrase “taking into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...ebrew based on the current Hebrew date (taking into consideration the current time w.r.t. sunset)(TAKE_INTO_CONSIDERATION)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/jewish_calendar.markdown(3 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/jewish_calendar.markdown
[style] ~189-~189: The phrase “taking into consideration” may be wordy. To make your writing clearer, consider replacing it.
Context: ...ebrew based on the current Hebrew date (taking into consideration the current time w.r.t. sunset)
(TAKE_INTO_CONSIDERATION)
⏰ 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
🔇 Additional comments (1)
source/_integrations/jewish_calendar.markdown (1)
153-156: Verify default values match implementation
The updated table marksdate,after_sunset,nusach, andlanguageas optional with defaults of today, true, and Hebrew respectively. Please confirm these defaults align with the integration’s code (e.g., the action schema or service handler).
Co-authored-by: Tsvi Mostovicz <ttmost@gmail.com>
|
@home-assistant rename Update Jewish calendar omer counting service documentation |
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
nextbranch.Summary by CodeRabbit
dateandlanguageparameters with default values.after_sunsetparameter to adjust counting based on Hebrew date after sunset.after_sunsetoption.