[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
01/02: doc: Add tips for Vim users.
|
From: |
Ludovic Courtès |
|
Subject: |
01/02: doc: Add tips for Vim users. |
|
Date: |
Fri, 27 Apr 2018 12:45:16 -0400 (EDT) |
civodul pushed a commit to branch master
in repository guix.
commit 60912a888d4c238850da38efe2cbf39a29dbf877
Author: Ludovic Courtès <address@hidden>
Date: Fri Apr 27 15:12:26 2018 +0200
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 d8929fa..2792fe2 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
address@hidden 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,
address@hidden://www.vim.org/scripts/script.php?script_id=3998,
address@hidden 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.