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

Add "summary" besides "name" to clarify description #37511

Merged
merged 7 commits into from
Feb 17, 2025

Conversation

NoRi2909
Copy link
Contributor

@NoRi2909 NoRi2909 commented Feb 17, 2025

Proposed change

The "description" fields of both the todo.add_item and the todo.update_item action refer to the "summary" of the item.

This is currently missing so this commit adds it besides "name" in the description of the "item" field.

In addition the inconsistent capitalization of "item" and "to-do" is fixed.

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
    • Clarified the To-do list integration guides by updating descriptions to indicate that a to-do item now includes both a name and a summary.
    • Adjusted the table structure for item data attributes in the todo.add_item and todo.update_item actions for consistency.

The "description" field of both the todo.add_item and the todo.update_item action refer to the "summary" of the item.

This is currently missing so this commit adds it besides "name" in the description of the "item" field.
@home-assistant home-assistant bot added the current This PR goes into the current branch label Feb 17, 2025
Copy link

netlify bot commented Feb 17, 2025

Deploy Preview for home-assistant-docs ready!

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

@NoRi2909 NoRi2909 marked this pull request as ready for review February 17, 2025 12:20
@NoRi2909 NoRi2909 requested a review from a team as a code owner February 17, 2025 12:20
Copy link
Contributor

coderabbitai bot commented Feb 17, 2025

📝 Walkthrough

Walkthrough

The documentation for the To-do list integration has been updated to refine the descriptions of the item attribute in both the todo.add_item and todo.update_item actions. The changes clarify that this attribute now represents both the name and summary of the to-do item without altering any underlying functionality.

Changes

File Changes Summary
source/_integrations/todo.markdown Updated the item attribute description for todo.add_item and todo.update_item actions to indicate that it includes both the name and summary of the to-do item.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6aa2a59 and d6f9560.

📒 Files selected for processing (1)
  • source/_integrations/todo.markdown (2 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/todo.markdown

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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

@home-assistant home-assistant bot marked this pull request as draft February 17, 2025 12:31
@home-assistant
Copy link

Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍

Learn more about our pull request process.

@NoRi2909 NoRi2909 requested a review from abmantis February 17, 2025 12:41
@NoRi2909 NoRi2909 marked this pull request as ready for review February 17, 2025 12:41
Copy link
Contributor

@abmantis abmantis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@abmantis abmantis merged commit 70723aa into home-assistant:current Feb 17, 2025
7 checks passed
@github-actions github-actions bot locked and limited conversation to collaborators Feb 18, 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.

To-do list: The main field of an item is inconsistently referenced as "summary"
2 participants