22.5.4 Formatação de código

When writing Scheme code, we follow common wisdom among Scheme programmers. In general, we follow the Riastradh’s Lisp Style Rules. This document happens to describe the conventions mostly used in Guile’s code too. It is very thoughtful and well written, so please do read it.

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 (see Development in 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

See Invoking guix style, for more information.

Se você estiver editando código com o Vim, recomendamos que execute :set autoindent para que seu código seja automaticamente recuado na medida em que você digita. Além disso, o paredit.vim pode ajudá-lo a lidar com todos esses parênteses.

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.