22.9.4 Formatação de código

Ao escrever código Scheme, seguimos a sabedoria comum entre os programadores Scheme. Em geral, seguimos o Riastradh’s Lisp Style Rules. Este documento descreve as convenções mais usadas no código de Guile também. Ele é muito bem pensado e bem escrito, então, por favor, leia.

Alguns formulários especiais introduzidos no Guix, como a macro substitute*, possuem regras especiais de recuo. Estes são definidos no arquivo .dir-locals.el, que o Emacs usa automaticamente. Observe também que o Emacs-Guix fornece o modo guix-devel-mode que recua e destaca o código Guix corretamente (veja Development em O manual de referência do Emacs-Guix).

Se você não usa o Emacs, por favor, certifique-se que o seu editor conhece estas regras. Para recuar automaticamente uma definição de pacote, você também pode executar:

./pre-inst-env guix style package

Veja Invoking guix style, para mais informações.

Nós exigimos que todos os procedimentos de nível superior carreguem uma docstring. Porém, este requisito pode ser relaxado para procedimentos privados simples no espaço de nomes (guix build …).

Os procedimentos não devem ter mais de quatro parâmetros posicionais. Use os parâmetros de palavra-chave para procedimentos que levam mais de quatro parâmetros.