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

Fixed missing keybind in tooltip #8632

Merged
merged 1 commit into from
Nov 1, 2024
Merged

Fixed missing keybind in tooltip #8632

merged 1 commit into from
Nov 1, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Nov 1, 2024

Motivation and context

Resolved #8625

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • Bug Fixes

    • Updated keyboard shortcut for switching draw modes to ensure correct functionality in the annotation process.
  • Chores

    • Refined shortcut handling for improved user experience without introducing new features or altering existing functionalities.

Copy link
Contributor

coderabbitai bot commented Nov 1, 2024

Walkthrough

The changes in the pull request focus on the SingleShapeSidebar component within the single-shape-sidebar.tsx file. The primary modification involves updating the keyboard shortcut for switching draw modes, specifically changing the reference from normalizedKeyMap.SWITCH_DRAW_MODE_SINGLE_SHAPE_CONTROLS to normalizedKeyMap.SWITCH_DRAW_MODE_SINGLE_SHAPE. This adjustment ensures the correct handling of keyboard shortcuts without altering the component's overall functionality or logic.

Changes

File Change Summary
cvat-ui/src/components/annotation-page/single-shape-workspace/single-shape-sidebar/single-shape-sidebar.tsx Updated shortcut key mapping for switching draw modes, adjusting from SWITCH_DRAW_MODE_SINGLE_SHAPE_CONTROLS to SWITCH_DRAW_MODE_SINGLE_SHAPE.

Assessment against linked issues

Objective Addressed Explanation
Missing keybind for object finishing in Single Shape mode (#8625) The change does not address the missing keybind issue.

Poem

🐰 In the sidebar where shapes do play,
A shortcut's changed to brighten the day.
With keys that dance and lines that flow,
Drawing shapes is now a show!
Hooray for tweaks, let creativity grow! 🎨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a652191 and 8c76d53.

📒 Files selected for processing (1)
  • cvat-ui/src/components/annotation-page/single-shape-workspace/single-shape-sidebar/single-shape-sidebar.tsx (1 hunks)
🔇 Additional comments (1)
cvat-ui/src/components/annotation-page/single-shape-workspace/single-shape-sidebar/single-shape-sidebar.tsx (1)

514-514: LGTM: Keyboard shortcut reference updated correctly.

The change from SWITCH_DRAW_MODE_SINGLE_SHAPE_CONTROLS to SWITCH_DRAW_MODE_SINGLE_SHAPE aligns with the keyboard shortcut defined in the component shortcuts section, fixing the missing keybind issue.

Let's verify the keyboard shortcut mapping is consistent across the codebase:

✅ Verification successful

Keyboard shortcut mapping is consistent across the codebase

The verification confirms:

  • No references to the old shortcut SWITCH_DRAW_MODE_SINGLE_SHAPE_CONTROLS exist
  • The new shortcut SWITCH_DRAW_MODE_SINGLE_SHAPE is properly defined and used consistently in the component:
    • As a shortcut definition
    • As a keyboard event handler
    • In the UI text reference
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for any remaining references to the old shortcut key
# and verify the new shortcut key is properly defined

# Test 1: Check for any remaining references to the old shortcut
echo "Checking for old shortcut references..."
rg "SWITCH_DRAW_MODE_SINGLE_SHAPE_CONTROLS"

# Test 2: Verify the new shortcut is properly defined
echo "Verifying new shortcut definition..."
rg "SWITCH_DRAW_MODE_SINGLE_SHAPE"

Length of output: 793


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.

@bsekachev bsekachev changed the title Fixed tooltip Fixed missing keybind in tooltip Nov 1, 2024
Copy link

sonarcloud bot commented Nov 1, 2024

@codecov-commenter
Copy link

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.31%. Comparing base (a652191) to head (8c76d53).

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8632      +/-   ##
===========================================
+ Coverage    74.28%   74.31%   +0.02%     
===========================================
  Files          401      401              
  Lines        43395    43395              
  Branches      3945     3945              
===========================================
+ Hits         32237    32247      +10     
+ Misses       11158    11148      -10     
Components Coverage Δ
cvat-ui 78.68% <ø> (+0.04%) ⬆️
cvat-server 70.56% <ø> (ø)

@bsekachev bsekachev merged commit f0a578a into develop Nov 1, 2024
34 checks passed
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.

Missing keybind for object finishing in Single Shape mode
2 participants