blob: 0e39c3069d8b78505c5fd8cc0bb76279076396fa (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
# Elisp Conventions
Some of this aligns with existing style guides. Some of it does not.
In general, prefer functions with fixed arities instead of variadic
alternatives.
- Namespace functions with `namespace/function-name`
- Use `ensure`, `assert`, `refute` whenever possible.
- When talking about encoding and decoding, let's use the words "encoding" and
"decoding" rather than the myriad of other variants that appear like:
- `marshalling` and `unmarshalling`
- `parse` and `deparse`, `serialize`, `stringify`
- `unpickle` and `pickle` (Python)
- `from-string` and `to-string`
- TODO: Add more examples of these; there should be close to a dozen.
- Annotate assertions with `!` endings.
- Prefer the Scheme style of `predicate?`
- Variadic functions *should* encode this by appending * onto their
name. E.g. `maybe/nil?*`
|
