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

Clarify remove vs. delete #21297

Merged
merged 4 commits into from
Jul 5, 2024
Merged

Clarify remove vs. delete #21297

merged 4 commits into from
Jul 5, 2024

Conversation

matthiasdebaat
Copy link
Collaborator

@matthiasdebaat matthiasdebaat commented Jul 4, 2024

Breaking change

Proposed change

Type of change

  • Dependency upgrade
  • Bugfix (non-breaking change which fixes an issue)
  • New feature (thank you!)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

  • This PR fixes or closes issue: fixes #
  • This PR is related to issue or discussion:
  • Link to documentation pull request:

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • Tests have been added to verify that the new code works.

If user exposed functionality or configuration variables are added/changed:

Summary by CodeRabbit

  • Documentation
    • Clarified the distinction between "Remove" and "Delete" actions in the content. "Remove" now implies a reversible action, while "Delete" signifies a permanent and non-recoverable action.

Copy link
Contributor

coderabbitai bot commented Jul 4, 2024

Walkthrough

Walkthrough

The changes primarily refine the terminology used to differentiate between "Remove" and "Delete" within the documentation. "Remove" now clearly indicates a reversible action, while "Delete" signifies a permanent, non-recoverable action. This ensures better clarity and understanding of these terms moving forward.

Changes

File Path Summary
gallery/src/pages/Text/remove-delete-add-create.markdown Updates terminology to distinguish between reversible "Remove" actions and irreversible "Delete" actions, emphasizing the semantic differences.

Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE

Commits

Files that changed from the base of the PR and between b8e9657 and 7dfbf32.

Files selected for processing (1)
  • gallery/src/pages/Text/remove-delete-add-create.markdown (2 hunks)
Additional context used
Markdownlint
gallery/src/pages/Text/remove-delete-add-create.markdown

6-6: null
Multiple top-level headings in the same document

(MD025, single-title, single-h1)

Additional comments not posted (2)
gallery/src/pages/Text/remove-delete-add-create.markdown (2)

15-15: Fix capitalization.

Only proper nouns start with an uppercase character.

- The term _Remove_ should always be used when an item/setting or content is to be removed or disassociated, but the action can be reversed or reapplied.
+ The term _remove_ should always be used when an item/setting or content is to be removed or disassociated, but the action can be reversed or reapplied.

Likely invalid or redundant comment.


28-28: Fix capitalization.

Only proper nouns start with an uppercase character.

- The term _Delete_ should always be used to refer to any action that will cause the permanent deletion of an item/setting or content.
+ The term _delete_ should always be used to refer to any action that will cause the permanent deletion of an item/setting or content.

Likely invalid or redundant comment.


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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@github-actions github-actions bot added the Design Related to Home Assistant design gallery label Jul 4, 2024
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: 4

gallery/src/pages/Text/remove-delete-add-create.markdown Outdated Show resolved Hide resolved
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: 4

gallery/src/pages/Text/remove-delete-add-create.markdown Outdated Show resolved Hide resolved
gallery/src/pages/Text/remove-delete-add-create.markdown Outdated Show resolved Hide resolved
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: 5

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

@frenck frenck added the smash Indicator this PR is close to finish for merging or closing label Jul 4, 2024
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

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

Thanks, @matthiasdebaat 👍

../Frenck

@frenck frenck merged commit f995f19 into home-assistant:dev Jul 5, 2024
14 checks passed
@matthiasdebaat matthiasdebaat deleted the patch-3 branch July 5, 2024 08:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla-signed Design Related to Home Assistant design gallery smash Indicator this PR is close to finish for merging or closing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants