aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorzeertzjq <zeertzjq@outlook.com>2022-05-31 07:06:34 +0800
committerGitHub <noreply@github.com>2022-05-31 07:06:34 +0800
commitd404d68c929a272eb7ccbc3cc370673e005e2a4b (patch)
treed3309882e70f32cadc65f8ec6e0f3230fb2f6747
parentb5dd562e08727877d973718e7a75804cace259dd (diff)
downloadrneovim-d404d68c929a272eb7ccbc3cc370673e005e2a4b.tar.gz
rneovim-d404d68c929a272eb7ccbc3cc370673e005e2a4b.tar.bz2
rneovim-d404d68c929a272eb7ccbc3cc370673e005e2a4b.zip
docs: clarify that nvim_strwidth counts control characters as one cell (#18802)
-rw-r--r--runtime/doc/api.txt2
-rw-r--r--src/nvim/api/vim.c2
2 files changed, 2 insertions, 2 deletions
diff --git a/runtime/doc/api.txt b/runtime/doc/api.txt
index 965b8e6492..5a44e90f2a 100644
--- a/runtime/doc/api.txt
+++ b/runtime/doc/api.txt
@@ -1706,7 +1706,7 @@ nvim_set_vvar({name}, {value}) *nvim_set_vvar()*
nvim_strwidth({text}) *nvim_strwidth()*
Calculates the number of display cells occupied by `text`.
- <Tab> counts as one cell.
+ Control characters including <Tab> count as one cell.
Parameters: ~
{text} Some text
diff --git a/src/nvim/api/vim.c b/src/nvim/api/vim.c
index 5c3c16d6b0..fc3d0549b9 100644
--- a/src/nvim/api/vim.c
+++ b/src/nvim/api/vim.c
@@ -480,7 +480,7 @@ Object nvim_notify(String msg, Integer log_level, Dictionary opts, Error *err)
}
/// Calculates the number of display cells occupied by `text`.
-/// <Tab> counts as one cell.
+/// Control characters including <Tab> count as one cell.
///
/// @param text Some text
/// @param[out] err Error details, if any