6f40ad55f5
There's little reason for users to use these macros in their private configs over plain ol' `with-eval-after-load` and `use-package`, unless they're writing their own modules. It's my fault for signal boosting them in documentation and whenever I'm asked for help, because beginners now believe they are somehow required for Doom to work correctly (there are guides out there telling beginners that migrating to Doom involves replacing all instances of `with-eval-after-load` and `use-package` in their pre-existing configs with `after!` and `use-package!` -- which was never true). What's more, I plan to replace `use-package`, internally, so the `use-package!` macro won't exist for much longer. |
||
|---|---|---|
| .. | ||
| .doommodule | ||
| config.el | ||
| packages.el | ||
| README.org | ||
:ui hl-todo
Description unfold
This module adds syntax highlighting for various tags in code comments, such as
TODO, FIXME, and NOTE, among others.
Maintainers
Module flags
This module has no flags.
Packages
Hacks
No hacks documented for this module.
TODO Changelog
This module does not have a changelog yet.
Installation
Enable this module in your doom! block.
This module has no external requirements.
TODO Usage
This module's usage documentation is incomplete. Complete it?
By enabling this module, the following keywords will be highlighted if they occur in code comments:
TODO: For things that need to be done, just not today.HACK: For tidbits that are unconventional and not intended uses of the constituent parts, and may break in a future update.FIXME: For problems that will become bigger problems later if not fixed ASAP.REVIEW: for things that were done hastily and/or hasn't been thoroughly tested. it may not even be necessary!NOTE: For especially important gotchas with a given implementation, directed at another user other than the author.DEPRECATED: For things that just gotta go and will soon be gone.BUG: For a known bug that needs a workaround.XXX: For warning about a problematic or misguiding code.
TODO Configuration
This module's configuration documentation is incomplete. Complete it?
To add your own ITEMS you would need to configure them using
hl-todo-keyword-faces:
;; in $DOOMDIR/config.el
(with-eval-after-load 'hl-todo
(setq hl-todo-keyword-faces
`(("FOO" . ,(face-foreground "MY COLOUR HEX CODE"))
("BAR" . ,(face-foreground 'my-colour-var)))))Troubleshooting
There are no known problems with this module. Report one?
Frequently asked questions
This module has no FAQs yet. Ask one?
TODO Appendix
This module has no appendix yet. Write one?