From 913fdafb11b2422d31f744742ef1c3805f230fd9 Mon Sep 17 00:00:00 2001 From: Thomas Voss Date: Sat, 9 Nov 2024 11:57:53 +0100 Subject: emacs: Add docstrings --- .config/emacs/modules/mm-modeline.el | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/.config/emacs/modules/mm-modeline.el b/.config/emacs/modules/mm-modeline.el index 4b4f0e0..b19a56d 100644 --- a/.config/emacs/modules/mm-modeline.el +++ b/.config/emacs/modules/mm-modeline.el @@ -39,7 +39,7 @@ (defconst mm-modeline-mode-acronyms '("css" "csv" "gsp" "html" "json" "mhtml" "scss" "toml" "tsv") - "TODO") + "List of acronyms in major mode names that should be capitalized.") (defconst mm-modeline-remap-alist '(("Bmenu" . "BMenu") @@ -48,7 +48,12 @@ ("Imake" . "IMake") ("Js" . "JavaScript") ("Ts Mode" . "Tree-Sitter Mode")) - "TODO") + "Alist of substrings in major mode names that should be remapped. +Some major modes have substrings that would be better displayed in +another manner. For example expanding an abbreviation such as ‘Js’ to +its expanded form ‘JavaScript’, or fixing the casing of words with a +prefix such as ‘Gmake’ to ‘GMake’. This alist maps the original text to +the text it should be mapped to.") (mm-modeline--define-component mm-modeline-major-mode-name (propertize -- cgit v1.2.3