diff options
| author | Vincent Ambo <mail@tazj.in> | 2021-12-13T22·51+0300 |
|---|---|---|
| committer | Vincent Ambo <mail@tazj.in> | 2021-12-13T23·15+0300 |
| commit | 019f8fd2113df4c5247c3969c60fd4f0e08f91f7 (patch) | |
| tree | 76a857f61aa88f62a30e854651e8439db77fd0ea /users/wpcarro/emacs/elisp-conventions.md | |
| parent | 464bbcb15c09813172c79820bcf526bb10cf4208 (diff) | |
| parent | 6123e976928ca3d8d93f0b2006b10b5f659eb74d (diff) | |
subtree(users/wpcarro): docking briefcase at '24f5a642' r/3226
git-subtree-dir: users/wpcarro git-subtree-mainline: 464bbcb15c09813172c79820bcf526bb10cf4208 git-subtree-split: 24f5a642af3aa1627bbff977f0a101907a02c69f Change-Id: I6105b3762b79126b3488359c95978cadb3efa789
Diffstat (limited to 'users/wpcarro/emacs/elisp-conventions.md')
| -rw-r--r-- | users/wpcarro/emacs/elisp-conventions.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/users/wpcarro/emacs/elisp-conventions.md b/users/wpcarro/emacs/elisp-conventions.md new file mode 100644 index 000000000000..0e39c3069d8b --- /dev/null +++ b/users/wpcarro/emacs/elisp-conventions.md @@ -0,0 +1,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?*` |