docs(surround): clarify case when cursor is on target default identifier

Resolve echasnovski#968
scottmckendry · Jun 14, 2024 · 460a8bf · 460a8bf
1 parent c5e4e0f
commit 460a8bf
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 6 deletions.
diff --git a/doc/mini-surround.txt b/doc/mini-surround.txt
@@ -197,9 +197,13 @@ Notes:
   whitespace: open includes it left and right parts, close does not.
 - Output value of `b` alias is same as `)`. For `q` alias - same as `"`.
 - Default surrounding is activated for all characters which are not
-  configured surrounding identifiers. Note: due to special handling of
-  underlying `x.-x` Lua pattern (see |MiniSurround-search-algorithm|), it
-  doesn't really support non-trivial `[count]` for "cover" search method.
+  configured surrounding identifiers. Notes:
+    - Due to special handling of underlying `x.-x` Lua pattern
+      (see |MiniSurround-search-algorithm|), it doesn't really support
+      non-trivial `[count]` for "cover" search method.
+    - When cursor is exactly on the identifier character while there are
+      two matching candidates on both left and right, the one resulting in
+      region with smaller width is preferred.
 
 ------------------------------------------------------------------------------
                                                          *MiniSurround-glossary*

diff --git a/lua/mini/surround.lua b/lua/mini/surround.lua
@@ -195,9 +195,13 @@
 ---   whitespace: open includes it left and right parts, close does not.
 --- - Output value of `b` alias is same as `)`. For `q` alias - same as `"`.
 --- - Default surrounding is activated for all characters which are not
----   configured surrounding identifiers. Note: due to special handling of
----   underlying `x.-x` Lua pattern (see |MiniSurround-search-algorithm|), it
----   doesn't really support non-trivial `[count]` for "cover" search method.
+---   configured surrounding identifiers. Notes:
+---     - Due to special handling of underlying `x.-x` Lua pattern
+---       (see |MiniSurround-search-algorithm|), it doesn't really support
+---       non-trivial `[count]` for "cover" search method.
+---     - When cursor is exactly on the identifier character while there are
+---       two matching candidates on both left and right, the one resulting in
+---       region with smaller width is preferred.
 ---@tag MiniSurround-surround-builtin
 
 --- Note: this is similar to |MiniAi-glossary|.