Skip to content

Commit 75de178

Browse files
authored
docs: Add note about open/closing surrounds to README.
Resolves #410
1 parent a868c25 commit 75de178

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ respectively. For the following examples, `*` will denote the cursor position:
7373
Old text Command New text
7474
--------------------------------------------------------------------------------
7575
surr*ound_words ysiw) (surround_words)
76+
surr*ound_words ysiw( ( surround_words )
7677
*make strings ys$" "make strings"
7778
[delete ar*ound me!] ds] delete around me!
7879
remove <b>HTML t*ags</b> dst remove HTML tags
@@ -81,7 +82,9 @@ respectively. For the following examples, `*` will denote the cursor position:
8182
delete(functi*on calls) dsf function calls
8283
```
8384

84-
Detailed information on how to use this plugin can be found in
85+
Note that surrounding with an opening delimiter (e.g. `(`) will add a space before/after
86+
the selection, while surrounding with the closing delimiter (e.g. `)`) will not include
87+
the spaces. Detailed information on how to use this plugin can be found in
8588
[`:h nvim-surround.usage`](https://github.com/kylechui/nvim-surround/blob/main/doc/nvim-surround.txt).
8689

8790
## :gear: Configuration

0 commit comments

Comments
 (0)