docs(pairs): clarify that it works only with two character pair

echasnovski · Oct 8, 2024 · 16408bc · 16408bc
1 parent 319361e
commit 16408bc
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/doc/mini-pairs.txt b/doc/mini-pairs.txt
@@ -6,8 +6,8 @@ MIT License Copyright (c) 2021 Evgeni Chasnovski
 ==============================================================================
 
 Features:
-- Functionality to work with 'paired' characters conditional on cursor's
-  neighborhood (two characters to its left and right).
+- Functionality to work with two "paired" characters conditional on cursor's
+  neighborhood (character to its left and character to its right).
 
 - Usage should be through making appropriate mappings using |MiniPairs.map|
   or in |MiniPairs.setup| (for global mapping), |MiniPairs.map_buf| (for

diff --git a/lua/mini/pairs.lua b/lua/mini/pairs.lua
@@ -6,8 +6,8 @@
 --- ==============================================================================
 ---
 --- Features:
---- - Functionality to work with 'paired' characters conditional on cursor's
----   neighborhood (two characters to its left and right).
+--- - Functionality to work with two "paired" characters conditional on cursor's
+---   neighborhood (character to its left and character to its right).
 ---
 --- - Usage should be through making appropriate mappings using |MiniPairs.map|
 ---   or in |MiniPairs.setup| (for global mapping), |MiniPairs.map_buf| (for

diff --git a/readmes/mini-pairs.md b/readmes/mini-pairs.md
@@ -26,7 +26,7 @@ https://user-images.githubusercontent.com/24854248/173044991-18653715-9b4e-444e-
 
 ## Features
 
-- Functionality to work with 'paired' characters conditional on cursor's neighborhood (two characters to its left and right).
+- Functionality to work with two "paired" characters conditional on cursor's neighborhood (character to its left and character to its right).
 - Usage should be through making appropriate mappings using `MiniPairs.map()` or in `MiniPairs.setup()` (for global mapping), `MiniPairs.map_buf()` (for buffer mapping).
 - Pairs get automatically registered to be recognized by `<BS>` and `<CR>`.