emenel/doomemacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Update/improve documentation for core defuns

Browse source
This commit is contained in:
Henrik Lissner 2017-02-09 04:25:32 -05:00
parent 85a5d7b5ac
commit be90fe8682
4 changed files with 39 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

17
core/core.el
View file

@ -2,14 +2,15 @@
;;; Naming conventions:
;;
;; doom-... A public variable or function (non-interactive use)
;; doom--... A private variable, function (non-interactive use) or macro
;; doom/... An interactive function
;; doom:... An evil operator, motion or command
;; doom|... A hook
;; doom*... An advising function
;; ...! Macro, shortcut alias or defsubst
;; @... A generator macro for keybinds
;; doom-... public variables or functions (non-interactive)
;; doom--... private anything (non-interactive), not safe for direct use
;; doom/... an interactive function
;; doom:... an evil operator, motion or command
;; doom|... hook function
;; doom*... advising functions
;; doom!... interaction commands exclusively for installing external dependencies
;; @... a macro, public shortcut alias or a generator macro for keybinds
;; %... functions used for in-snippet logic
;; +... Any of the above, but part of a module, e.g. +emacs-lisp|init-hook
;;
;; Autoloaded functions are in core/autoload/*.el and modules/*/*/autoload.el or