Skip to content

Add option to treat events that starts and ends at midnight as all day events #38874

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
Open
wants to merge 1 commit into
base: next
Choose a base branch
from
Open

Add option to treat events that starts and ends at midnight as all day events #38874

wants to merge 1 commit into from

Conversation

oyvindwe
Copy link
Contributor

@oyvindwe oyvindwe commented May 4, 2025 •
edited by coderabbitai bot
Loading

Proposed change

Document new configuration option to the Remote Calendar integration.

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 Remote Calendar integration documentation to include a new configuration option for treating midnight-to-midnight events as all-day events.
    • Added an example snippet and explanation for the new setting in the configuration section.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels May 4, 2025
@netlify Netlify
Copy link

netlify bot commented May 4, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

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

@oyvindwe oyvindwe mentioned this pull request May 4, 2025
Open
19 tasks
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented May 4, 2025

📝 Walkthrough

Walkthrough

The documentation for the Remote Calendar integration was updated to add a new configuration parameter. This parameter allows users to treat events that start and end at midnight in the Home Assistant time zone as all-day events. The documentation now includes a description of this option, an example snippet demonstrating its use, and an explanation within the configuration section. No changes to code or functional behavior are present; all updates are limited to documentation.

Changes

File Change Summary
source/_integrations/remote_calendar.markdown Updated documentation to add a new configuration option for treating midnight-to-midnight events as all-day events; included example and description.

Sequence Diagram(s)

No sequence diagram generated as the changes are documentation-only and do not affect control flow or introduce new features in the codebase.

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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate sequence diagram to generate a sequence diagram of the changes in 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.

coderabbitai[bot]
coderabbitai bot reviewed May 4, 2025
View reviewed changes
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 (2)
source/_integrations/remote_calendar.markdown (2)

42-43: Hyphenate “all-day” when used as a modifier
When used adjectivally, “all-day events” should be hyphenated for clarity.

 {% configuration_basic %}
-Treat events that start and end at midnight as all day events:
+Treat events that start and end at midnight as all-day events:
 {% endconfiguration_basic %}
🧰 Tools
🪛 LanguageTool

[uncategorized] ~42-~42: When ‘all-day’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...vents that start and end at midnight as all day events: description: Enable to treat ...

(ALL_DAY_HYPHEN)

[uncategorized] ~43-~43: When ‘all-day’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...the same time zone as Home Assistant as all day events. {% endconfiguration_basic %} #...

(ALL_DAY_HYPHEN)

43-43: Refine description phrasing for clarity
The description’s current phrasing (“Enable to treat…”) can be made more natural by indicating the behavior when toggled.

-  description: Enable to treat events that start and end at midnight in the same time zone as Home Assistant as all day events.
+  description: When enabled, treats events that start and end at midnight in the same time zone as Home Assistant as all-day events.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~43-~43: When ‘all-day’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...the same time zone as Home Assistant as all day events. {% endconfiguration_basic %} #...

(ALL_DAY_HYPHEN)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 59a34bd and d9f0acb.

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

[uncategorized] ~42-~42: When ‘all-day’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...vents that start and end at midnight as all day events: description: Enable to treat ...

(ALL_DAY_HYPHEN)

[uncategorized] ~43-~43: When ‘all-day’ is used as a modifier, it is usually spelled with a hyphen.
Context: ...the same time zone as Home Assistant as all day events. {% endconfiguration_basic %} #...

(ALL_DAY_HYPHEN)

🔇 Additional comments (1)
source/_integrations/remote_calendar.markdown (1)

39-40: Including the option flow snippet in the right place
Adding the {% include integrations/option_flow.md %} before the new configuration fields aligns with the standard option flow UI documentation pattern.

c0ffeeca7
c0ffeeca7 approved these changes May 5, 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, @oyvindwe 👍

@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label May 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
awaits-parent Awaits the merge of an parent PR has-parent This PR has a parent PR in a other repo next This PR goes into the next branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@oyvindwe @c0ffeeca7