aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEvgeni Chasnovski <evgeni.chasnovski@gmail.com>2025-01-15 12:36:00 +0200
committerGitHub <noreply@github.com>2025-01-15 02:36:00 -0800
commit09bcb310681e3b87d5b8c5eb547b182554cff7b4 (patch)
treefc239f2d658f5d2620e0b99c37fa90ad371959e2
parent9552fe7ef907c5c8164abb50699e97d03de1285a (diff)
downloadrneovim-09bcb310681e3b87d5b8c5eb547b182554cff7b4.tar.gz
rneovim-09bcb310681e3b87d5b8c5eb547b182554cff7b4.tar.bz2
rneovim-09bcb310681e3b87d5b8c5eb547b182554cff7b4.zip
fix(docs): replace `yxx` mappings with `g==` #31947
Problem: `yx` uses "y" prefix, which shadows a builtin operator. Solution: Use `g=` (in the form of `g==` currently), drawing from precedent of CTRL-= and 'tpope/vim-scriptease'.
-rw-r--r--runtime/doc/helphelp.txt2
-rw-r--r--runtime/doc/news.txt2
-rw-r--r--runtime/doc/terminal.txt2
-rw-r--r--runtime/doc/treesitter.txt2
-rw-r--r--runtime/doc/various.txt4
-rw-r--r--runtime/ftplugin/help.lua6
-rw-r--r--runtime/lua/vim/treesitter/query.lua2
7 files changed, 10 insertions, 10 deletions
diff --git a/runtime/doc/helphelp.txt b/runtime/doc/helphelp.txt
index f7009aebfe..72d37f6088 100644
--- a/runtime/doc/helphelp.txt
+++ b/runtime/doc/helphelp.txt
@@ -193,7 +193,7 @@ Jump to specific subjects by using tags. This can be done in two ways:
Use CTRL-T or CTRL-O to jump back.
Use ":q" to close the help window.
-Use `yxx` to execute the current Lua/Vimscript code block.
+Use `g==` to execute the current Lua/Vimscript code block.
If there are several matches for an item you are looking for, this is how you
can jump to each one of them:
diff --git a/runtime/doc/news.txt b/runtime/doc/news.txt
index 8c4130b3f2..f897220374 100644
--- a/runtime/doc/news.txt
+++ b/runtime/doc/news.txt
@@ -229,7 +229,7 @@ DIAGNOSTICS
EDITOR
-• Use |yxx| in :help docs to execute Lua and Vimscript code examples.
+• Use |g==| in :help docs to execute Lua and Vimscript code examples.
• Improved |paste| handling for redo (dot-repeat) and macros (|recording|):
• Redoing a large paste is significantly faster and ignores 'autoindent'.
• Replaying a macro with |@| also replays pasted text.
diff --git a/runtime/doc/terminal.txt b/runtime/doc/terminal.txt
index a7f278990c..0ab7151728 100644
--- a/runtime/doc/terminal.txt
+++ b/runtime/doc/terminal.txt
@@ -166,7 +166,7 @@ directory indicated in the request. >lua
})
To try it out, select the above code and source it with `:'<,'>lua` (or
-`yxx`), then run this command in a :terminal buffer: >
+`g==`), then run this command in a :terminal buffer: >
printf "\033]7;file://./foo/bar\033\\"
diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt
index 41679f80ca..83fa2c5a17 100644
--- a/runtime/doc/treesitter.txt
+++ b/runtime/doc/treesitter.txt
@@ -1339,7 +1339,7 @@ parse({lang}, {query}) *vim.treesitter.query.parse()*
`info.captures`).
• `info.patterns`: information about predicates.
- Example (to try it, use `yxx` or select the code then run `:'<,'>lua`): >lua
+ Example (to try it, use `g==` or select the code then run `:'<,'>lua`): >lua
local query = vim.treesitter.query.parse('vimdoc', [[
; query
((h1) @str
diff --git a/runtime/doc/various.txt b/runtime/doc/various.txt
index 611e820cab..662519d415 100644
--- a/runtime/doc/various.txt
+++ b/runtime/doc/various.txt
@@ -554,8 +554,8 @@ gO Show a filetype-specific, navigable "outline" of the
*:sl!* *:sleep!*
:[N]sl[eep]! [N][m] Same as above, but hide the cursor.
- *yxx*
-yxx Executes the current code block.
+ *g==*
+g== Executes the current code block.
Works in |help| buffers.
diff --git a/runtime/ftplugin/help.lua b/runtime/ftplugin/help.lua
index ed8f93c71c..479e4d8b9f 100644
--- a/runtime/ftplugin/help.lua
+++ b/runtime/ftplugin/help.lua
@@ -57,7 +57,7 @@ for _, match, metadata in query:iter_matches(tree:root(), 0, 0, -1) do
if name == 'code' then
vim.api.nvim_buf_set_extmark(0, run_message_ns, start, 0, {
- virt_text = { { 'Run with `yxx`', 'LspCodeLens' } },
+ virt_text = { { 'Run with `g==`', 'LspCodeLens' } },
})
local code = vim.treesitter.get_node_text(node, 0)
local lang_node = match[metadata[id].lang][1] --[[@as TSNode]]
@@ -69,7 +69,7 @@ for _, match, metadata in query:iter_matches(tree:root(), 0, 0, -1) do
end
end
-vim.keymap.set('n', 'yxx', function()
+vim.keymap.set('n', 'g==', function()
local pos = vim.api.nvim_win_get_cursor(0)[1]
local code_block = code_blocks[pos]
if not code_block then
@@ -82,5 +82,5 @@ vim.keymap.set('n', 'yxx', function()
end, { buffer = true })
vim.b.undo_ftplugin = (vim.b.undo_ftplugin or '')
- .. '\n exe "nunmap <buffer> gO" | exe "nunmap <buffer> yxx"'
+ .. '\n exe "nunmap <buffer> gO" | exe "nunmap <buffer> g=="'
vim.b.undo_ftplugin = vim.b.undo_ftplugin .. ' | call v:lua.vim.treesitter.stop()'
diff --git a/runtime/lua/vim/treesitter/query.lua b/runtime/lua/vim/treesitter/query.lua
index ad648f36cc..e43d0a8ad4 100644
--- a/runtime/lua/vim/treesitter/query.lua
+++ b/runtime/lua/vim/treesitter/query.lua
@@ -301,7 +301,7 @@ api.nvim_create_autocmd('OptionSet', {
--- - `captures`: a list of unique capture names defined in the query (alias: `info.captures`).
--- - `info.patterns`: information about predicates.
---
---- Example (to try it, use `yxx` or select the code then run `:'<,'>lua`):
+--- Example (to try it, use `g==` or select the code then run `:'<,'>lua`):
--- ```lua
--- local query = vim.treesitter.query.parse('vimdoc', [[
--- ; query