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

Restrict the length of tooltip #132

Merged
merged 1 commit into from
May 11, 2024
Merged

Restrict the length of tooltip #132

merged 1 commit into from
May 11, 2024

Conversation

hanjinliu
Copy link
Owner

@hanjinliu hanjinliu commented May 11, 2024

Summary by CodeRabbit

  • Refactor
    • Updated data roles for better alignment with standard naming conventions, enhancing clarity in data handling.
  • Bug Fixes
    • Improved tooltip display by truncating long values, ensuring tooltips are concise and informative.

Copy link

coderabbitai bot commented May 11, 2024

Walkthrough

The recent updates across various files primarily focus on standardizing data roles and enhancing tooltip functionality. Roles such as TextColorRole and BackgroundColorRole have been renamed to ForegroundRole and BackgroundRole respectively, while tooltip texts are now truncated for better readability.

Changes

File Path Change Summary
.../_item_model.py & .../_cell.py Renamed data roles from specific color roles to more generic foreground and background roles.
.../_spreadsheet.py Updated tooltip methods to truncate long values, ensuring tooltips are concise and informative.

🐰✨
A hop, a skip, in code we dip,
Colors align, tooltips neatly clipped.
Fields of data, now succinct,
With each commit, our code distinct.
🌟📜🌟


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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.

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

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between cfb0233 and f388f9b.
Files selected for processing (3)
  • tabulous/_qt/_table/_base/_item_model.py (2 hunks)
  • tabulous/_qt/_table/_spreadsheet.py (1 hunks)
  • tabulous/widgets/_component/_cell.py (1 hunks)
Additional comments not posted (3)
tabulous/widgets/_component/_cell.py (1)

99-99: Change from TextColorRole to ForegroundRole aligns with data role standardization.

tabulous/_qt/_table/_base/_item_model.py (2)

149-152: Tooltip truncation logic correctly implemented to enhance UI clarity.


44-44: Enhanced background color rendering aligns with UI improvements.

Comment on lines +152 to +158
val_repr = repr(val)
if len(val_repr) > 64:
val_repr = val_repr[:60] + "..." + val_repr[-4:]
if dtype is None:
return f"{val!r} (dtype: infer){ref}"
return f"{val_repr} (dtype: infer){ref}"
else:
return f"{val!r} (dtype: {dtype}){ref}"
return f"{val_repr} (dtype: {dtype}){ref}"
Copy link

Choose a reason for hiding this comment

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

Refactor tooltip truncation logic for efficiency and robustness.

-            val_repr = repr(val)
-            if len(val_repr) > 64:
-                val_repr = val_repr[:60] + "..." + val_repr[-4:]
+            val_repr = (repr(val)[:60] + "..." + repr(val)[-4:]) if len(repr(val)) > 64 else repr(val)

Consider adding a try-except block around the repr(val) to handle any exceptions that might occur during the conversion, ensuring the application's stability.


Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
val_repr = repr(val)
if len(val_repr) > 64:
val_repr = val_repr[:60] + "..." + val_repr[-4:]
if dtype is None:
return f"{val!r} (dtype: infer){ref}"
return f"{val_repr} (dtype: infer){ref}"
else:
return f"{val!r} (dtype: {dtype}){ref}"
return f"{val_repr} (dtype: {dtype}){ref}"
val_repr = (repr(val)[:60] + "..." + repr(val)[-4:]) if len(repr(val)) > 64 else repr(val)
if dtype is None:
return f"{val_repr} (dtype: infer){ref}"
else:
return f"{val_repr} (dtype: {dtype}){ref}"

@hanjinliu hanjinliu merged commit 676249d into main May 11, 2024
10 checks passed
@hanjinliu hanjinliu deleted the tooltip-length branch May 11, 2024 09:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant