From 16408bcb789c37aeabaeb739aa55aac78b731e3a Mon Sep 17 00:00:00 2001 From: Evgeni Chasnovski Date: Tue, 8 Oct 2024 11:21:36 +0300 Subject: [PATCH] docs(pairs): clarify that it works only with two character pair --- doc/mini-pairs.txt | 4 ++-- lua/mini/pairs.lua | 4 ++-- readmes/mini-pairs.md | 2 +- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/doc/mini-pairs.txt b/doc/mini-pairs.txt index 2e890ef0..c47e815c 100644 --- 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 index baa0ba18..c32efb31 100644 --- 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 index 6f70c354..bb47673c 100644 --- 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 `` and ``.