auto-pairs-surround documentation

alexherbo2 / auto-pairs.kak

Auto-pairing of characters for Kakoune

https://kakoune.org

77 stars 18 forks source link

auto-pairs-surround documentation #27

Closed CBenoit closed 5 years ago

CBenoit commented 5 years ago

Hi,

This is in the README:

map global user S -docstring 'Surround++' ': auto-pairs-surround _ _ * *<ret>'

What is the meaning of auto-pairs-surround parameters? There is no documentation for it. An explanation for this should at least be added in the README.

alexherbo2 commented 5 years ago

It’s for adding extra pairs.

With this pair, you can for example surround Markdown **foo** or _bar_. It’s not a pair you always want though, hence the extra parameters to the command.

CBenoit commented 5 years ago

Thank you! May I open a pull request to add this in the readme?

alexherbo2 commented 5 years ago

Yep