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.

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

Refactor: Rename "More info dialog" to "Details view" for clearer tra… #22537

Open
wants to merge 4 commits into
base: dev
Choose a base branch
from
Open

Refactor: Rename "More info dialog" to "Details view" for clearer tra… #22537

wants to merge 4 commits into from
+6 −6

Conversation

iemafzalhassan
Copy link

For issue #22517, here’s a PR description that aligns with the requested format:

Breaking change

Proposed change

This PR renames the "More info dialog" to "Details view" across the codebase to streamline terminology and simplify translations. This adjustment aligns with the naming conventions used in other components, providing a clearer and more cohesive user experience.

Type of change

  • Code quality improvements to existing code or addition of tests

Example configuration

Additional information

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:

  • Documentation added/updated for [www.home-assistant.io][docs-repository]

Additional Information

This PR fixes or closes issue: Resolves #22517

Documentation Impact: Documentation changes may not be needed as this only affects UI terminology. However, if deemed necessary, I’m available to contribute to the required documentation updates.

Contributor GitHub: @iemafzalhassan

home-assistant[bot]
home-assistant bot previously requested changes Oct 25, 2024
View reviewed changes
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 @iemafzalhassan

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 home-assistant bot marked this pull request as draft October 25, 2024 21:24
@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.

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 25, 2024 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

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

@iemafzalhassan iemafzalhassan marked this pull request as ready for review October 25, 2024 21:25
iemafzalhassan

This comment was marked as off-topic.

Sign in to view

@piitaya
Copy link
Member

piitaya commented Oct 28, 2024

Hi 👋 Thank you for the contribution. The "more info" terms is well know for HA users. It's not something we can change easily. I agree "more info dialog" is not a good term. I will discuss that point with the UX/UI team.

Also, "detail view" is not the right term because we already have "view" in the dashboard and it's another element.

@iemafzalhassan
Copy link
Author

Hi @piitaya ,

There is a concern about using "detail view" due to the existing. Perhaps we can brainstorm alternatives that avoid confusion, a more accurate description than the "view" terminal while still pro "more info dialog."

I’d be happy to collaborate on finding a term that is both user-familiar and clear. I'm looking forward to hearing your thoughts!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bramkragten bramkragten bramkragten left review comments

@home-assistant home-assistant[bot] home-assistant[bot] left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
cla-signed hacktoberfest
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Rename "More info dialog" to just "Details view" to streamline translations
3 participants
@iemafzalhassan @piitaya @bramkragten