diff options
| author | Amin Bandali <amin@aminb.org> | 2018-04-21 11:55:11 -0400 |
|---|---|---|
| committer | Amin Bandali <amin@aminb.org> | 2018-04-21 11:55:11 -0400 |
| commit | e4cd0d4952436f8fdc2c009aaf1a8d8ab25a8006 (patch) | |
| tree | f0150402371fcda2b03c2dfb5184e8245093bbc9 | |
| parent | 63a849c3da1bd6eb3e0cc722ab0419b3d68c4f57 (diff) | |
| download | configs-e4cd0d4952436f8fdc2c009aaf1a8d8ab25a8006.tar.gz configs-e4cd0d4952436f8fdc2c009aaf1a8d8ab25a8006.tar.xz configs-e4cd0d4952436f8fdc2c009aaf1a8d8ab25a8006.zip | |
[emacs] add naming conventions
| -rw-r--r-- | emacs/init.org | 21 |
1 files changed, 18 insertions, 3 deletions
diff --git a/emacs/init.org b/emacs/init.org index 5f96e69..5aa530e 100644 --- a/emacs/init.org +++ b/emacs/init.org @@ -59,6 +59,24 @@ file. ;; THIS FILE IS AUTO-GENERATED FROM `init.org'. #+end_src +** Naming conventions + +The conventions below were inspired by [[https://github.com/hlissner/doom-emacs][Doom]]'s conventions, found +[[https://github.com/hlissner/doom-emacs/blob/5dacbb7cb1c6ac246a9ccd15e6c4290def67757c/core/core.el#L3-L17][here]]. Naturally, I use my initials, =ab=, instead of =doom=. + +#+begin_src emacs-lisp :comments none +;; Naming conventions: +;; +;; ab-... public variables or non-interactive functions +;; ab--... private anything (non-interactive), not safe for direct use +;; ab/... an interactive function; safe for M-x or keybinding +;; ab:... an evil operator, motion, or command +;; ab|... a hook function +;; ab*... an advising function +;; ab@... a hydra command +;; ab!... a macro +#+end_src + * Initial setup :PROPERTIES: :CUSTOM_ID: initial-setup @@ -101,9 +119,6 @@ Reset the variables back to default after init. ,load-file-name elapsed)))) #+end_src -Note that I'll be using my initials, =ab=, as a prefix for the -variables and functions I define throughout my init file. - ** Package management *** =straight.el= |