Open
Conversation
Suggest another key binding which is not in collision with the default key bindings
Reviewer's GuideThis 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
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
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>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>
Author
|
Unlike what |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
g => vas the default key binding and update the example accordingly