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

Fix docs fern-action-remove #519

Merged
merged 2 commits into from
Feb 13, 2025

Conversation

matukoto
Copy link
Contributor

@matukoto matukoto commented Feb 11, 2025

  • Replace fern-action-trash with fern-action-remove in example.
  • Fix typo.

Summary by CodeRabbit

  • Documentation
    • Updated deletion command details to clarify that removal is permanent and irreversible.
    • Renamed command references for improved clarity and consistency.

Copy link

coderabbitai bot commented Feb 11, 2025

Walkthrough

The changes update the documentation for the fern plugin to clarify its delete functionality. The key mappings have been renamed to better reflect their actions. Specifically, the mapping for deleting nodes was renamed from <Plug>(fern-action-trash=) to <Plug>(fern-action-remove=), and similarly, <Plug>(my-trash) was renamed to <Plug>(my-remove). The action prompt has also been revised to emphasize that deletions are irreversible.

Changes

File Change Summary
doc/fern.txt Renamed <Plug>(fern-action-trash=) to <Plug>(fern-action-remove=) and <Plug>(my-trash) to <Plug>(my-remove). Updated deletion prompt text.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant FernPlugin
    participant FileSystem

    User->>+FernPlugin: Trigger <Plug>(fern-action-remove=)
    FernPlugin->>+FileSystem: Permanently delete file/directory
    FileSystem-->>-FernPlugin: Confirmation of deletion
    FernPlugin-->>-User: Action response
Loading

Poem

In the realm of code, I hop with glee,
A mapping change sets my spirit free.
Goodbye "trash", new "remove" takes the stage,
Files vanish fast, no turning the page.
I'm a coding bunny, dancing in ASCII delight, 🌟
Celebrating changes deep into the night!
Hop on and explore this new, crisp rewrite!


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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

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

🧹 Nitpick comments (1)
doc/fern.txt (1)

45-45: Update remaining references to "trash" for consistency.

There are still references to "trash" in the documentation that should be updated to maintain consistency with the action name change:

  1. Line 45: "trash" feature in Linux
  2. Lines 94-98: Section titled "System trash-bin support"

Consider updating these references to use "remove" instead of "trash" for consistency.

Also applies to: 94-98

🧰 Tools
🪛 LanguageTool

[grammar] ~45-~45: The correct preposition appears to be “on”.
Context: ...ern itself. Exception: "trash" feature in Linux. https://github.com/lambdalisue/...

(IN_WINDOWS)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cb5be74 and 42980dd.

📒 Files selected for processing (1)
  • doc/fern.txt (1 hunks)
🔇 Additional comments (2)
doc/fern.txt (2)

1261-1262: Fixed typo in the word "directory".

The typo in the word "directory" has been corrected.


1268-1269: Updated mapping example to use "remove" instead of "trash".

The mapping example has been updated to use <Plug>(my-remove) instead of <Plug>(my-trash) to maintain consistency with the action name change.

@lambdalisue lambdalisue merged commit ea72289 into lambdalisue:main Feb 13, 2025
13 checks passed
@matukoto matukoto deleted the fix-doc-remove-action branch February 13, 2025 10:34
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