aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorLudovic Courtès <ludo@gnu.org>2018-04-27 15:12:26 +0200
committerLudovic Courtès <ludo@gnu.org>2018-04-27 18:45:02 +0200
commit60912a888d4c238850da38efe2cbf39a29dbf877 (patch)
tree985a4d3d3e9f0e9bc915a658ba1f8ca4f41a3627 /doc
parentc441959819d0f59a10e6a8ece3eacacd0c410118 (diff)
downloadguix-60912a888d4c238850da38efe2cbf39a29dbf877.tar
guix-60912a888d4c238850da38efe2cbf39a29dbf877.tar.gz
doc: Add tips for Vim users.
* doc/contributing.texi (Formatting Code): Add a paragraph about Vim.
Diffstat (limited to 'doc')
-rw-r--r--doc/contributing.texi7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/contributing.texi b/doc/contributing.texi
index d8929fa2e4..2792fe2b29 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -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.