Skip to content

Propagate filtered shapes Documentation #8181

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

Merged
merged 2 commits into from
Aug 27, 2024
Merged

Conversation

mdacoca
Copy link
Contributor

@mdacoca mdacoca commented Jul 17, 2024

Motivation and context

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

  • New Features
    • Added "Propagate shapes" option to the Select action field in the Shapes Converter.
    • Enhanced Propagate function in the annotation interface to support filtering shapes and included a link to further documentation.
  • Documentation
    • Updated user documentation to reflect the new "Propagate shapes" feature and its availability.
    • Added references and links to the Shapes Converter in the Propagate function guide for better clarity.

Copy link
Contributor

coderabbitai bot commented Jul 17, 2024

Important

Review skipped

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

Walkthrough

The recent updates enhance the shapes conversion functionality in the documentation by introducing a new action, "Propagate shapes," to the Select action field. Additionally, the Propagate function now includes details about propagating only filtered shapes, linked to the Shapes converter for further clarification. These changes aim to provide more granular control and clear guidance within the annotation interface.

Changes

File Path Summary of Changes
site/content/en/docs/enterprise/... Updated Select action field to include Propagate shapes, reflecting changes for the Free plan.
site/content/en/docs/manual/... Added reference to propagating only filtered shapes in the Propagate function, with a link to Shapes converter.

Poem

In the land of shapes, a change so grand,
Propagate with ease, with just one command.
Filtered forms now glide and sway,
From frame to frame, they find their way.
A rabbit's cheer for tasks so bright,
Annotation's future, shining light! 🌟🐇


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

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

Outside diff range, codebase verification and nitpick comments (1)
site/content/en/docs/enterprise/shapes-converter.md (1)

39-39: Inconsistent descriptions of "Propagate shapes" action.

The "Propagate shapes" action is described differently in CHANGELOG.md and site/content/en/docs/enterprise/shapes-converter.md:

  • CHANGELOG.md describes it as creating copies of visible shapes on multiple frames forward or backward.
  • shapes-converter.md states it propagates all the filtered shapes from the current frame to the target frame.

Please ensure the descriptions are consistent across all documentation.

Analysis chain

Verify the consistency of the new "Propagate shapes" action.

The addition of "Propagate shapes" to the Select action dropdown is a significant change. It's crucial to ensure that this new functionality is consistently described across all relevant documentation to avoid confusion. Additionally, check if the implementation details and limitations, especially regarding the Free plan, are clear and accurate.

Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the consistency of the "Propagate shapes" action across documentation.
# Test: Search for mentions of "Propagate shapes" in other related documentation files.
rg --type markdown "Propagate shapes"

Length of output: 1185

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 2490153 and ec95f8e.

Files selected for processing (2)
  • site/content/en/docs/enterprise/shapes-converter.md (1 hunks)
  • site/content/en/docs/manual/basics/CVAT-annotation-Interface/objects-sidebar.md (1 hunks)
Additional comments not posted (2)
site/content/en/docs/manual/basics/CVAT-annotation-Interface/objects-sidebar.md (2)

56-56: Review the addition of the Shapes converter link.

The addition of a link to the Shapes converter in the context of filtering shapes is a useful enhancement for users. It directly connects the concept of propagation with the tool necessary for such actions, providing a seamless user experience. Ensure the link is correctly formatted and accessible.


55-56: Clarify the keyboard shortcut for the Propagate function.

The line mentions Ctrl + B as the shortcut for the Propagate function. This could be a typo or an actual change. It's important to verify this shortcut, as it's typically Ctrl + P in many applications for propagation-related actions.

Copy link

@bsekachev bsekachev merged commit ac258ae into develop Aug 27, 2024
14 checks passed
@bsekachev bsekachev deleted the ma/propagation-update branch August 29, 2024 08:02
bschultz96 pushed a commit to bschultz96/cvat that referenced this pull request Sep 12, 2024
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.

2 participants