doc: Add tips for Vim users.

* doc/contributing.texi (Formatting Code): Add a paragraph about Vim.
This commit is contained in:
Ludovic Courtès 2018-04-27 15:12:26 +02:00
parent c441959819
commit 60912a888d
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5

View file

@ -308,6 +308,13 @@ indent a whole file, omit the second argument:
./etc/indent-code.el gnu/services/@var{file}.scm
@end example
@cindex Vim, Scheme code editing
If you are editing code with Vim, we recommend that you run @code{:set
autoindent} so that your code is automatically indented as you type.
Additionally,
@uref{https://www.vim.org/scripts/script.php?script_id=3998,
@code{paredit.vim}} may help you deal with all these parentheses.
We require all top-level procedures to carry a docstring. This
requirement can be relaxed for simple private procedures in the
@code{(guix build @dots{})} name space, though.