From efd14ea6b14233c698508c3e982bd6492436b431 Mon Sep 17 00:00:00 2001 From: Case Duckworth Date: Tue, 10 Aug 2021 14:47:33 -0500 Subject: Add docstrings --- lisp/acdw-modeline.el | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/lisp/acdw-modeline.el b/lisp/acdw-modeline.el index 4e6b002..f1e7d27 100644 --- a/lisp/acdw-modeline.el +++ b/lisp/acdw-modeline.el @@ -23,6 +23,7 @@ (require 'minions) (defun acdw-modeline/buffer-name () ; gonsie + "Display the buffer name in a face reflecting its modified status." (propertize " %b " 'face (if (buffer-modified-p) @@ -38,6 +39,7 @@ (format-mode-line erc-modified-channels-object))) (defun acdw-modeline/god-mode-indicator () + "Display an indicator if `god-local-mode' is active." (when (bound-and-true-p god-local-mode) " God")) @@ -124,6 +126,7 @@ is, if point < mark." 'font-lock-face 'font-lock-variable-name-face)))) (defun acdw-modeline/text-scale () + "Display the text scaling from the modeline, if scaled." ;; adapted from https://github.com/seagle0128/doom-modeline (when (and (boundp 'text-scale-mode-amount) (/= text-scale-mode-amount 0)) @@ -134,11 +137,14 @@ is, if point < mark." text-scale-mode-amount))) (defun acdw-modeline/vc-branch () + "Display the version control branch of the current buffer in the modeline." ;; from https://www.gonsie.com/blorg/modeline.html, from Doom (if-let ((backend (vc-backend buffer-file-name))) (substring vc-mode (+ (if (eq backend 'Hg) 2 3) 2)))) (defun acdw-modeline/winum () + "Show the `winum' number of the current window in the modeline. +Only shows if there is more than one window." (when (and (bound-and-true-p winum-mode) (> winum--window-count 1)) (format winum-format (winum-get-number-string)))) -- cgit 1.4.1-21-gabe81