vim-surround icon indicating copy to clipboard operation
vim-surround copied to clipboard

Mention of spaces in Readme is confusing

Open Rybadour opened this issue 8 years ago • 5 comments

Let's make that braces and add some space (use } instead of { for no space): cs]{

This line had me confused, at first I read it as: "use { for no space" I almost created a pull request to fix this but then I noticed my misunderstanding.

Maybe it would be better to state it simply. Remove the "(use } instead of { for no space)" and have a separate sentence like: "To not insert space use }"

Rybadour avatar Feb 09 '17 15:02 Rybadour

Came to figure out why there were added spaces, thanks 😛

carlosvigil avatar Mar 13 '17 23:03 carlosvigil

I think it should probably be explained with something like "use a closing delimiter to skip inserting spaces", which explains the concept.

lleaff avatar Apr 05 '17 13:04 lleaff

I like that wording. Maybe append a parenthetical: "e.g., ) not (".

tpope avatar Apr 05 '17 16:04 tpope

Thank you, this exactly answers my question for replacing without adding spaces.

raycheung avatar Jun 01 '17 02:06 raycheung

I agree that this wasn't very clear. For a new person, stating "(use } instead of { for no space)" doesn't do justice to the difference.

Instead it should be more explicit and simply say: "Use the 'opening' character to include a space around the wrap, or use the 'closing' character to not include spaces around the wrap"

fanuch avatar Mar 02 '20 00:03 fanuch