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

[DE] Add intent for removing items from shopping list #2397

Closed
wants to merge 3 commits into from

Conversation

Lesekater
Copy link

@Lesekater Lesekater commented Sep 25, 2024

Added a intent to add items to shopping lists.

Summary by CodeRabbit

  • New Features

    • Introduced a new intent for removing items from a shopping list, enhancing user interaction.
    • Added personalized response templates in German to confirm item removal.
    • Included various sentence structures in German to support user requests for item removal.
  • Tests

    • Implemented test cases to ensure accurate recognition of removal requests for specific items.

Copy link

@home-assistant home-assistant bot left a comment

Choose a reason for hiding this comment

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

Hi @Lesekater

It seems you haven't yet signed a CLA. Please do so here.

Once you do that we will be able to review and accept this pull request.

Thanks!

@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.

@Lesekater
Copy link
Author

Started draft for core repo:
home-assistant/core#126786

@Lesekater Lesekater marked this pull request as ready for review September 25, 2024 20:18
Copy link

coderabbitai bot commented Sep 25, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

A new intent, HassShoppingListRemoveItem, has been introduced to facilitate the removal of items from a shopping list. This intent includes a required slot for specifying the item to be removed. Corresponding response templates and sentence structures have been created in German to support user interactions. Additionally, test cases have been established to ensure the intent correctly recognizes various phrasing options for removing items from the shopping list.

Changes

File Path Change Summary
intents.yaml Added new intent HassShoppingListRemoveItem for removing items from a shopping list.
responses/de/HassShoppingListRemoveItem.yaml Introduced response template for HassShoppingListRemoveItem indicating an item has been removed.
sentences/de/shopping_list_HassShoppingListRemoveItem.yaml Defined sentence structures for the HassShoppingListRemoveItem intent in German.
tests/de/shopping_list_HassShoppingListRemoveItem.yaml Added test sentences for the HassShoppingListRemoveItem intent, focused on removing "Milch".

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 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

@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

🧹 Outside diff range and nitpick comments (4)
sentences/de/shopping_list_HassShoppingListRemoveItem.yaml (2)

3-10: LGTM: Intent definition and sentences are well-structured.

The HassShoppingListRemoveItem intent is well-defined with a comprehensive set of sentence structures for removing items from a shopping list in German. The use of optional verb endings (e.g., "entfern[e]") is a good practice for handling both formal and informal forms of address.

Consider adding a sentence structure that uses the accusative case, such as:

- "(entfern[e]|streich[e]|nehm[e]|nimm) <item> (von|aus) <meine_liste_akkusativ>"

This would provide more flexibility in sentence construction.


11-14: LGTM: Expansion rules are well-defined, but accusative case is unused.

The expansion rules for list names in both dative and accusative cases are well-defined, providing flexibility in referring to the shopping list. The item placeholder correctly references a shopping list item.

The accusative case expansion rule (meine_liste_akkusativ) is defined but not used in the current sentence structures. To make use of this rule, consider adding a sentence structure that uses the accusative case, as suggested in the previous comment. Alternatively, if the accusative case is not needed, you could remove the unused expansion rule to keep the file concise.

tests/de/shopping_list_HassShoppingListRemoveItem.yaml (2)

19-22: Intent definition is correct, but there's an extra space in the slot value.

The intent name "HassShoppingListRemoveItem" accurately reflects the action of removing an item from a shopping list. The slot "item" is correctly defined.

However, there's an extra space after "milch" in the slot value. This might cause issues in intent matching or item processing.

Consider removing the extra space:

-        item: "milch "
+        item: "milch"

23-23: Response is correct but could be more generic.

The response "milch entfernt" correctly confirms the removal of the item in German. However, it's specifically tailored to "milch" (milk) and might not be suitable for other items.

Consider making the response more generic to accommodate any item. For example:

response: "{item} entfernt"

This way, the response will dynamically include the name of the removed item.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 0d33861 and 0b9c987.

📒 Files selected for processing (4)
  • intents.yaml (1 hunks)
  • responses/de/HassShoppingListRemoveItem.yaml (1 hunks)
  • sentences/de/shopping_list_HassShoppingListRemoveItem.yaml (1 hunks)
  • tests/de/shopping_list_HassShoppingListRemoveItem.yaml (1 hunks)
🔇 Additional comments not posted (6)
sentences/de/shopping_list_HassShoppingListRemoveItem.yaml (2)

1-2: LGTM: File structure and language declaration are correct.

The file correctly declares German (de) as the language and follows the expected YAML structure for intent definitions.


1-14: Overall, excellent implementation with minor suggestions for improvement.

This YAML file successfully defines the HassShoppingListRemoveItem intent for German language users, providing a comprehensive set of sentence structures for removing items from a shopping list. The implementation is well-structured and follows best practices for intent definition.

To further improve the file:

  1. Consider adding a sentence structure that uses the accusative case to make use of the meine_liste_akkusativ expansion rule.
  2. If the accusative case is not needed, consider removing the unused expansion rule to keep the file concise.

These minor adjustments would enhance the consistency and efficiency of the intent definition.

tests/de/shopping_list_HassShoppingListRemoveItem.yaml (1)

1-1: LGTM: Language specification is correct.

The language is correctly specified as "de" for German, which matches the content of the test sentences.

intents.yaml (3)

265-273: LGTM: New intent structure is well-defined and consistent.

The new HassShoppingListRemoveItem intent is well-structured and consistent with other intents in the file. It correctly defines the necessary properties and a required slot for removing an item from the shopping list.


265-273: Verify intent purpose: Removing vs. Adding items

The PR objectives mention adding an intent for adding items to shopping lists, but this new intent is for removing items. Please clarify if this is intentional or if an additional intent for adding items should be included.


265-273: Good: Consistent with existing shopping list intent and completes the set of operations

The new HassShoppingListRemoveItem intent is consistent with the existing HassShoppingListAddItem intent. Together, they provide a complete set of operations for managing shopping list items (adding and removing), which enhances the functionality of the shopping list feature.

@mib1185
Copy link
Contributor

mib1185 commented Sep 27, 2024

First, many thanks for your contribution 👍

Started draft for core repo: home-assistant/core#126786

I think we should first have the core PR merged, before adding intents, therefore I'm setting this PR here to draft mode, as long as the core PR is not merged.

Furthermore it might also need an discussion first 🤔
@synesthesiam what do you think?

@mib1185 mib1185 marked this pull request as draft September 27, 2024 13:50
Copy link
Contributor

@mib1185 mib1185 left a comment

Choose a reason for hiding this comment

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

besides waiting for the core PR, I've already some review comments on this one.

btw. the title and description needs to be adjusted, since you're adding the remove itents, not the add intents 😉

@Lesekater Lesekater changed the title [DE] Add intent for adding items to shopping list [DE] Add intent for removing items from shopping list Sep 27, 2024
@frenck
Copy link
Member

frenck commented Oct 26, 2024

FYI @Lesekater @mib1185 The linked core PR has been closed.

../Frenck

@Lesekater
Copy link
Author

FYI @Lesekater @mib1185 The linked core PR has been closed.

../Frenck

Thx for mentioning it.

Yes, i closed it, after working on a similar PR for the todo component, where allenporter mentioned, that it would probably be better to focus on the mark item as completed intent rather than the more destructive remove item itent (home-assistant/core#127046 (comment)).

I opened another core PR for marking items as complete on the shopping list (home-assistant/core#128565). I could probably create a new PR here too if the core PR goes through, but I think most of the wording can stay the same between item completion and item removal.

@mib1185
Copy link
Contributor

mib1185 commented Oct 27, 2024

I would vote for closing this one here, since it was designed and targeted to another approach.
Further, please wait with opening a new PR here, as long as the core PR (home-assistant/core#128565) is not accepted and merged - this is to avoid unnecessary efforts on your side and also on the reviewers side.

@mib1185 mib1185 closed this Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants