me
/
guix
Archived
1
0
Fork 0
Code

doc: Add note about .dir-locals.el. 

* HACKING (Coding Style): Mention special indentation rules and
  .dir-locals.el.
master
Ludovic Courtès 2013-08-30 23:53:13 +02:00
parent e1c5a8357a
commit 1a2e649561
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
HACKING
View File

@ -115,9 +115,14 @@ In general, we follow the [[http://mumble.net/~campbell/scheme/style.txt][Riastr
to describe the conventions mostly used in Guile’s code too. It is very
thoughtful and well written, so please do read it.
In addition, we require all top-level procedures to carry a docstring. This
requirement can be relaxed for simple private procedures in the (guix build …)
name space, though.
Some special forms introduced in Guix, such as the ‘substitute*’ macro, have
special indentation rules. These are defined in the .dir-locals.el file,
which Emacs automatically uses. If you do not use Emacs, please make sure to
let your editor know the rules.
We require all top-level procedures to carry a docstring. This requirement
can be relaxed for simple private procedures in the (guix build …) name space,
though.
Procedures should not have more than four positional parameters. Use keyword
parameters for procedures that take more than four parameters.