22.9.4 Formato del código

Cuando escribimos código Scheme, seguimos la sabiduría común entre las programadoras Scheme. En general, seguimos las Reglas de estilo Lisp de Riastradh. Este documento resulta que también describe las convenciones más usadas en el código Guile. Está lleno de ideas y bien escrito, así que recomendamos encarecidamente su lectura.

Algunas formas especiales introducidas en Guix, como el macro substitute* tienen reglas de indentación especiales. Estas están definidas en el archivo .dir-locals.el, el cual Emacs usa automáticamente. Fíjese que además Emacs-Guix proporciona el modo guix-devel-mode que indenta y resalta adecuadamente el código de Guix (see Development in The Emacs-Guix Reference Manual).

Si no usa Emacs, por favor asegúrese de que su editor conoce esas reglas. Para indentar automáticamente una definición de paquete también puede ejecutar:

./pre-inst-env guix style package

See Invoking guix style, for more information.

Requerimos que todos los procedimientos del nivel superior tengan una cadena de documentación. Este requisito puede relajarse para procedimientos simples privados en el espacio de nombres (guix build …) no obstante.

Los procedimientos no deben tener más de cuatro parámetros posicionales. Use parámetros con palabras clave para procedimientos que toman más de cuatro parámetros.