Update Jewish calendar docs based on updated library #37507
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe pull request updates the Jewish Calendar integration documentation. It revises the holiday sensor by removing the Changes
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? 🪧 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/jewish_calendar.markdown (1)
87-89: Emphasis Style and Punctuation in Attribute List
The updated description now states that the holiday sensor includes 2 attributes: type, and id, reflecting the removal of thetype_idattribute. However, the static analysis tool recommends using underscores (e.g., type and id) instead of asterisks per MD049, and it also flagged a potential punctuation issue with the list. Consider revising this line to improve both style consistency and punctuation. For example:-The holiday sensor includes 2 attributes: *type*, and *id*. +The holiday sensor includes 2 attributes: _type_ and _id_.🧰 Tools
🪛 LanguageTool
[uncategorized] ~89-~89: Possible missing comma found.
Context: ...ype*, and id. The id is useful for automations so they're not language-dependent. On ...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
87-87: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
89-89: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
89-89: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/jewish_calendar.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/jewish_calendar.markdown
[uncategorized] ~89-~89: Possible missing comma found.
Context: ...ype*, and id. The id is useful for automations so they're not language-dependent. On ...
(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
source/_integrations/jewish_calendar.markdown
87-87: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
89-89: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
89-89: Emphasis style
Expected: underscore; Actual: asterisk
(MD049, emphasis-style)
⏰ 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 (3)
source/_integrations/jewish_calendar.markdown (3)
93-94: Clarification of Sensor Output Examples
The examples now state that in Israel, on the 30th of Shvat, the sensor will report "Rosh Chodesh, Family day" and on the 22nd of Tishrei, "Shmini Atzeret, Simchat Torah." These examples are clear and align with the updated documentation. Please verify that these outputs match the updated library’s behavior.
97-101: Updated Holiday Table Structure
The table now correctly reflects the removal of the deprecatedtype_idattribute by including only the columns for ID, English, Hebrew, and Type. The revised format improves clarity and aligns with the new documentation standards. Ensure that the table's formatting remains consistent across different renderings.
1-140: Overall Documentation Update
The changes throughout the document successfully update the Jewish Calendar integration documentation to reflect the revised holiday sensor attributes and output examples. In addition to content accuracy, please address the markdown style recommendations (using underscores for emphasis and reviewing punctuation) to meet the project's style guidelines.🧰 Tools
🪛 LanguageTool
[uncategorized] ~30-~30: Did you mean: “By default,”?
Context: ...ion of the weekly portion and holidays. By default it will consider the location as Israel...(BY_DEFAULT_COMMA)
[uncategorized] ~38-~38: Did you mean: “By default,”?
Context: ... ### Minutes after sunset for Havdalah By default havdalah time is considered the moment ...(BY_DEFAULT_COMMA)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ... Sensor list ### Data sensors -date: Shows the hebrew date for today. - `par...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...rew date for today. -parshat_hashavua: Shows the weekly portion (parshat hasha...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...low for more info)_. -day_of_the_omer: An integer sensor indicating the day of...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~53-~53: Loose punctuation mark.
Context: ... is not currently the Omer. -daf_yomi: Shows the date's daf yomi page. ### Ti...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~61-~61: Loose punctuation mark.
Context: ...ormatted UTC time. -alot_hashachar: First light of dawn (Alot Hashachar - ע...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ... the Gr"a. -latest_time_for_shma_mg_a: Last time for the reading of the Shma a...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...e MG"A. -latest_time_for_tefilla_gr_a: Last time for full shacharit according ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~67-~67: Loose punctuation mark.
Context: ...e Gr"a. -latest_time_for_tefilla_mg_a: Last time for full shacharit according ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...according to the MG"A. -chatzot_hayom: Half way through the day (Chatzot Hayom...(UNLIKELY_OPENING_PUNCTUATION)
[grammar] ~68-~68: The adjective or adverb “halfway” is spelled as one word.
Context: ...cording to the MG"A. -chatzot_hayom: Half way through the day (Chatzot Hayom - חצות ה...(WAY_COMPOUNDS)
[uncategorized] ~75-~75: Loose punctuation mark.
Context: ...g Shabbat. -upcoming_shabbat_havdalah: The time of havdalah for either the cur...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~76-~76: Loose punctuation mark.
Context: ...r details.) -upcoming_candle_lighting: The time of candle lighting for either ...(UNLIKELY_OPENING_PUNCTUATION)
[misspelling] ~76-~76: Possible spelling mistake found.
Context: .... If, for example, today is Sunday, and Rosh Hashana is Monday night through Wednesday night...(EN_MULTITOKEN_SPELLING_TWO)
[misspelling] ~76-~76: Possible spelling mistake found.
Context: ...t, this reports the candle lighting for Rosh Hashana on Monday night. This avoids a situatio...(EN_MULTITOKEN_SPELLING_TWO)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ..._lightingsensor. -upcoming_havdalah`: The time of havdalah for either the cur...(UNLIKELY_OPENING_PUNCTUATION)
[misspelling] ~77-~77: Possible spelling mistake found.
Context: .... If, for example, today is Sunday, and Rosh Hashana is Monday night through Wednesday night...(EN_MULTITOKEN_SPELLING_TWO)
[misspelling] ~77-~77: Possible spelling mistake found.
Context: ...ay night, this reports the havdalah for Rosh Hashana on Wednesday night. To always get the S...(EN_MULTITOKEN_SPELLING_TWO)
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...ary sensors -issur_melacha_in_effect: A boolean sensor indicating if melacha ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~82-~82: Loose punctuation mark.
Context: ...nd off otherwise. -erev_shabbat_hag: A boolean sensor indicating that there ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~83-~83: Loose punctuation mark.
Context: ...g Shabbat or Hag. -motzei_shabbat_hag: A boolean sensor indicating that Shabba...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~89-~89: Possible missing comma found.
Context: ...ype*, and id. The id is useful for automations so they're not language-dependent. On ...(AI_HYDRA_LEO_MISSING_COMMA)
🪛 markdownlint-cli2 (0.17.2)
21-21: Multiple consecutive blank lines
Expected: 1; Actual: 2(MD012, no-multiple-blanks)
57-57: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
57-57: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
59-59: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
59-59: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
75-75: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
75-75: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
87-87: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
89-89: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
89-89: Emphasis style
Expected: underscore; Actual: asterisk(MD049, emphasis-style)
Proposed change
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit