kovisoft / slimv

Official mirror of Slimv versions released on vim.org
455 stars 60 forks source link

Slightly improving docs for explaining electric returns #82

Open szmer opened 4 years ago

szmer commented 4 years ago

I've just started experimenting with Slimv coming from Spacemacs. I was a little surprised when I saw enclosing parens moving to new lines when I enter a newline. I kind of guessed the purpose (exploiting vim line editing features, yy, dd etc.), but it was not clear how to then automatically reformat the code "right". I imagine some completely new person could think that this is how Lisp code is supposed to be indented.

Then I found some SO questions where you mention electric return, and then this question with a looong gif which gave me the idea to input the closing parens manually and then they will reformat instead of appearing.

So I think some changes to docs could save users some confusion:

kovisoft commented 4 years ago

Ah, thanks for pointing out that the animgif link in the tutorial is dead. I changed it to a local copy. I'll also revise the docs.

kovisoft commented 4 years ago

Also updated the docs: added new tags on |newline|, |parentheses|, updated comments on electric return, fixed gif link in doc. See commit https://github.com/kovisoft/slimv/commit/e0dc4eb5e55700d70e1bb73b14152b23816122e7

szmer commented 4 years ago

Thanks, my scenario at least now seems to be well covered.