Skip to content

Update README.md#1

Open
vepain wants to merge 2 commits intoarxae:mainfrom
vepain:patch-1
Open

Update README.md#1
vepain wants to merge 2 commits intoarxae:mainfrom
vepain:patch-1

Conversation

@vepain
Copy link

@vepain vepain commented Oct 15, 2025

Suggest another key binding which is not in collision with the default key bindings

Summary by Sourcery

Refine README documentation to suggest a non-colliding default key binding and improve layout and formatting

Documentation:

  • Recommend using g => v as the default key binding and update the example accordingly
  • Add Note and Warning admonitions about customizing the key binding and avoiding the default collision
  • Enhance formatting with language-specified code fences and subheadings for the manual installation section

Suggest another key binding which is not in collision with the default key bindings
@sourcery-ai
Copy link

sourcery-ai bot commented Oct 15, 2025

Reviewer's Guide

This PR restructures the README by refining installation headers, standardizing code block syntax, updating the suggested key binding to avoid collisions, and adding note and warning admonitions for clarity.

File-Level Changes

Change Details Files
Standardize code block syntax and spacing
  • Added blank lines around sections and examples for readability
  • Updated code fences to use ```sh for shell commands
README.md
Refine installation section headings
  • Converted Linux/macOS and Windows list items into level-4 headings
  • Inserted blank lines before and after headings for consistency
README.md
Update key binding suggestion
  • Changed default binding in the example from ["g", "c"] to ["g", "v"]
  • Added explanatory text about associating the plugin with the new key binding
README.md
Add informational admonitions
  • Introduced a [!Note] block outlining customization options
  • Introduced a [!Warning] block highlighting the default collision with g => c
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey there - I've reviewed your changes - here's some feedback:

  • Fix the typo in “You need to asociate this plugin” to “associate.”
  • Ensure the toml code block is properly closed with triple backticks so the README renders correctly.
  • Github-flavored markdown doesn’t support [!Note]/[!Warning] blocks—consider using standard blockquotes or headings instead.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- Fix the typo in “You need to asociate this plugin” to “associate.”
- Ensure the toml code block is properly closed with triple backticks so the README renders correctly.
- Github-flavored markdown doesn’t support [!Note]/[!Warning] blocks—consider using standard blockquotes or headings instead.

## Individual Comments

### Comment 1
<location> `README.md:34` </location>
<code_context>
 ## Configuration
-add this to your **keymap.toml** file
+
+You need to asociate this plugin with a key binding.
+
+We suggest you associate this plugin with the `g => v` key binding.
</code_context>

<issue_to_address>
**issue (typo):** Typo: 'asociate' should be 'associate'.

Please update the spelling to 'associate'.

```suggestion
You need to associate this plugin with a key binding.
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Fix typo

Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com>
@vepain
Copy link
Author

vepain commented Oct 15, 2025

Unlike what sourcery-ai claims, [!Note] and [!Warning] blocks are supported, see https://github.com/orgs/community/discussions/16925

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