From 398b91b623125d7b8b5aeb7f07dc58b83fb109b0 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Mon, 23 May 2022 02:34:28 +0200 Subject: [PATCH] nit(hl-todo): revise keyword summaries in comments --- modules/ui/hl-todo/config.el | 22 ++++++++++------------ 1 file changed, 10 insertions(+), 12 deletions(-) diff --git a/modules/ui/hl-todo/config.el b/modules/ui/hl-todo/config.el index 3d010f388..9fc6bc479 100644 --- a/modules/ui/hl-todo/config.el +++ b/modules/ui/hl-todo/config.el @@ -6,25 +6,23 @@ :config (setq hl-todo-highlight-punctuation ":" hl-todo-keyword-faces - `(;; For things that need to be done, just not today. + '(;; For missing features or functionality that should be added at a + ;; later date. ("TODO" warning bold) - ;; For problems that will become bigger problems later if not - ;; fixed ASAP. + ;; For code (or code paths) that are broken or slow, and may become + ;; bigger problems later. ("FIXME" error bold) - ;; For tidbits that are unconventional and not intended uses of the - ;; constituent parts, and may break in a future update. + ;; For code smells, where questionable coding practices are + ;; intentionally used, and/or 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! + ;; For things that need confirmation that they work or more testing. ("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) - ;; For a known bug that needs a workaround + ;; These are extra, commonly seen annotation keywords. What they mean + ;; or are for depend on the project. + ("NOTE" success bold) ("BUG" error bold) - ;; For warning about a problematic or misguiding code ("XXX" font-lock-constant-face bold)))