From 60912a888d4c238850da38efe2cbf39a29dbf877 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= <ludo@gnu.org>
Date: Fri, 27 Apr 2018 15:12:26 +0200
Subject: [PATCH] doc: Add tips for Vim users.
* doc/contributing.texi (Formatting Code): Add a paragraph about Vim.
---
doc/contributing.texi | 7 +++++++
1 file changed, 7 insertions(+)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index d8929fa2e4d..2792fe2b296 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.
--
GitLab