mirror of
https://github.com/neovim/neovim.git
synced 2025-11-14 14:29:02 +00:00
docs(undotree): rename help tag #36497
Problem: confusing that there is the tag `undo-tree` (the Vim implementation) and `undotree` (the Lua plugin for visualization). Solution: rename tag to undotree-plugin. Mention the plugin in the docs of |undotree|.
This commit is contained in:
committed by
GitHub
parent
4110e6730a
commit
94ae48ff29
@@ -39,7 +39,7 @@ Help-link Loaded Short description ~
|
||||
|pi_zip.txt| Yes Zip archive explorer
|
||||
|spellfile.lua| Yes Install spellfile if missing
|
||||
|tohtml| Yes Convert buffer to html, syntax included
|
||||
|undotree| No Interactive textual undotree
|
||||
|undotree-plugin| No Interactive textual undotree
|
||||
|
||||
==============================================================================
|
||||
Builtin plugin: difftool *difftool*
|
||||
@@ -248,10 +248,10 @@ tohtml({winid}, {opt}) *tohtml.tohtml()*
|
||||
|
||||
|
||||
==============================================================================
|
||||
Builtin plugin: undotree *undotree*
|
||||
Builtin plugin: undotree *undotree-plugin*
|
||||
|
||||
open({opts}) *undotree.open()*
|
||||
Open a window that displays a textual representation of the undotree.
|
||||
Open a window that displays a textual representation of the |undo-tree|.
|
||||
|
||||
While in the window, moving the cursor changes the undo.
|
||||
|
||||
|
||||
@@ -133,7 +133,8 @@ option has been set to a different value. For example: >
|
||||
Above we only discussed one line of undo/redo. But it is also possible to
|
||||
branch off. This happens when you undo a few changes and then make a new
|
||||
change. The undone changes become a branch. You can go to that branch with
|
||||
the following commands.
|
||||
the following commands. The undo-tree of a file can be visualized and
|
||||
interactively applied using |undotree-plugin|.
|
||||
|
||||
This is explained in the user manual: |usr_32.txt|.
|
||||
|
||||
|
||||
@@ -294,7 +294,7 @@ end
|
||||
--- source buffer as its only argument and should return a string.
|
||||
--- @field title (string|fun(bufnr:integer):string|nil)?
|
||||
|
||||
--- Open a window that displays a textual representation of the undotree.
|
||||
--- Open a window that displays a textual representation of the [undo-tree].
|
||||
---
|
||||
--- While in the window, moving the cursor changes the undo.
|
||||
---
|
||||
|
||||
@@ -440,10 +440,13 @@ local config = {
|
||||
return 'Builtin plugin: ' .. name:lower()
|
||||
end,
|
||||
helptag_fmt = function(name)
|
||||
if name:lower() == 'spellfile' then
|
||||
name = name:lower()
|
||||
if name == 'spellfile' then
|
||||
name = 'spellfile.lua'
|
||||
elseif name == 'undotree' then
|
||||
name = 'undotree-plugin'
|
||||
end
|
||||
return name:lower()
|
||||
return name
|
||||
end,
|
||||
},
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user