aboutsummaryrefslogtreecommitdiff
path: root/runtime/lua/vim
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2025-06-05 07:05:27 +0800
committerGitHub <noreply@github.com>2025-06-05 07:05:27 +0800
commitb16dc698cf445635fe094fc3482d1647341ed952 (patch)
tree482685b395c7cae98499670a5938ec819a0cf3cf /runtime/lua/vim
parent5e4700152b79e090d880d2734e0eaec726f4b8a7 (diff)
parenta5bbdbb5d5a58a08a62e12d13fef906c04a6af74 (diff)
downloadrneovim-b16dc698cf445635fe094fc3482d1647341ed952.tar.gz
rneovim-b16dc698cf445635fe094fc3482d1647341ed952.tar.bz2
rneovim-b16dc698cf445635fe094fc3482d1647341ed952.zip
Merge pull request #34312 from zeertzjq/vim-d6c9ac9
vim-patch: doc updates
Diffstat (limited to 'runtime/lua/vim')
-rw-r--r--runtime/lua/vim/_meta/options.lua15
1 files changed, 5 insertions, 10 deletions
diff --git a/runtime/lua/vim/_meta/options.lua b/runtime/lua/vim/_meta/options.lua
index 957e8f9438..368b254610 100644
--- a/runtime/lua/vim/_meta/options.lua
+++ b/runtime/lua/vim/_meta/options.lua
@@ -6168,16 +6168,11 @@ vim.o.si = vim.o.smartindent
vim.bo.smartindent = vim.o.smartindent
vim.bo.si = vim.bo.smartindent
---- When on, a <Tab> in front of a line inserts blanks according to
---- 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
---- <BS> will delete a 'shiftwidth' worth of space at the start of the
---- line.
---- When off, a <Tab> always inserts blanks according to 'tabstop' or
---- 'softtabstop'. 'shiftwidth' is only used for shifting text left or
---- right `shift-left-right`.
---- What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
---- option. Also see `ins-expandtab`. When 'expandtab' is not set, the
---- number of spaces is minimized by using <Tab>s.
+--- When enabled, the <Tab> key will indent by 'shiftwidth' if the cursor
+--- is in leading whitespace. The <BS> key has the opposite effect.
+--- This behaves as if 'softtabstop' is set to the value of 'shiftwidth'.
+--- Have a look at section `30.5` of the user guide for detailed
+--- explanations on how Vim works with tabs and spaces.
---
--- @type boolean
vim.o.smarttab = true