From fa2b9d8afe502dcff5f3fc6abc606ce34fdbe533 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Fri, 10 Apr 2020 00:18:31 -0400 Subject: [PATCH] Comment hl-todo keywords --- modules/ui/hl-todo/config.el | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/modules/ui/hl-todo/config.el b/modules/ui/hl-todo/config.el index 09c793b74..5c7be0e92 100644 --- a/modules/ui/hl-todo/config.el +++ b/modules/ui/hl-todo/config.el @@ -5,11 +5,21 @@ :config (setq hl-todo-highlight-punctuation ":" hl-todo-keyword-faces - `(("TODO" warning bold) - ("FIXME" error bold) - ("HACK" font-lock-constant-face bold) - ("REVIEW" font-lock-keyword-face bold) - ("NOTE" success bold) + `(;; For things that need to be done, just not today. + ("TODO" warning bold) + ;; For problems that will become bigger problems later if not + ;; fixed ASAP. + ("FIXME" error bold) + ;; For tidbits that are unconventional and not intended uses of the + ;; constituent parts, and may break in a future update. + ("HACK" font-lock-constant-face bold) + ;; For things that were done hastily and/or hasn't been thoroughly + ;; tested. It may not even be necessary! + ("REVIEW" font-lock-keyword-face bold) + ;; For especially important gotchas with a given implementation, + ;; directed at another user other than the author. + ("NOTE" success bold) + ;; For things that just gotta go and will soon be gone. ("DEPRECATED" font-lock-doc-face bold))) ;; Use a more primitive todo-keyword detection method in major modes that