Skip to content

Commit 3bf3f3a

Browse files
docs(vimdoc): Auto-generate user / API documentation + vimtags
1 parent 5e51ca2 commit 3bf3f3a

File tree

1 file changed

+15
-4
lines changed

1 file changed

+15
-4
lines changed

doc/cursor-text-objects.txt

Lines changed: 15 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -107,6 +107,15 @@ Give your right-pinky a workout and install `cursor-text-objects.nvim` today!
107107
>lua
108108
{
109109
"ColinKennedy/cursor-text-objects.nvim",
110+
config = function()
111+
local down_description = "Operate from your current cursor to the end of some text-object."
112+
local up_description = "Operate from the start of some text-object to your current cursor."
113+
114+
vim.keymap.set("o", "[", "<Plug>(cursor-text-objects-up)", { desc = up_description })
115+
vim.keymap.set("o", "]", "<Plug>(cursor-text-objects-down)", { desc = down_description })
116+
vim.keymap.set("x", "[", "<Plug>(cursor-text-objects-up)", { desc = up_description })
117+
vim.keymap.set("x", "]", "<Plug>(cursor-text-objects-down)", { desc = down_description })
118+
end,
110119
version = "v1.*",
111120
}
112121
<
@@ -159,10 +168,12 @@ You can watch this plugin for changes by adding this URL to your RSS feed:
159168
==============================================================================
160169
6. Other Plugins *cursor-text-objects-other-plugins*
161170

162-
This template is full of various features. But if your plugin is only meant to
163-
be a simple plugin and you don’t want the bells and whistles that this
164-
template provides, consider instead using nvim-cursor-text-object
165-
<https://github.com/ellisonleao/nvim-plugin-template>
171+
This plugin is a sort-of successor to vim-ninja-feet
172+
<https://github.com/tommcdo/vim-ninja-feet> with some notable differences
173+
174+
- visual mode support
175+
- better edge-case handling
176+
- (IMO) better documenting what the code does / how it works
166177

167178
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
168179

0 commit comments

Comments
 (0)