From 69e47314a3fbcd27cbc952560bb2ba585d0189e4 Mon Sep 17 00:00:00 2001 From: Vincent Zhang Date: Mon, 2 Jul 2018 16:28:16 +0800 Subject: [PATCH] Update comments. --- doom-modeline.el | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/doom-modeline.el b/doom-modeline.el index 21b9b8c..e659efd 100644 --- a/doom-modeline.el +++ b/doom-modeline.el @@ -62,7 +62,7 @@ (defvar doom-modeline-buffer-file-name-style 'truncate-upto-project "Determines the style used by `doom-modeline-buffer-file-name'. - Given ~/Projects/FOSS/emacs/lisp/comint.el +Given ~/Projects/FOSS/emacs/lisp/comint.el truncate-upto-project => ~/P/F/emacs/lisp/comint.el truncate-upto-root => ~/P/F/e/lisp/comint.el truncate-all => ~/P/F/e/l/comint.el @@ -218,10 +218,10 @@ active.") (defmacro doom-modeline-def-modeline (name lhs &optional rhs) "Defines a modeline format and byte-compiles it. - NAME is a symbol to identify it (used by `doom-modeline' for retrieval). - LHS and RHS are lists of symbols of modeline segments defined with - `doom-modeline-def-segment'. - Example: +AME is a symbol to identify it (used by `doom-modeline' for retrieval). +LHS and RHS are lists of symbols of modeline segments defined with +`doom-modeline-def-segment'. +Example: (doom-modeline-def-modeline minimal (bar matches \" \" buffer-info) (media-info major-mode)) @@ -270,7 +270,7 @@ active.") (defun doom-modeline-project-root () "Get the path to the root of your project. - If STRICT-P, return nil if no project was found, otherwise return +If STRICT-P, return nil if no project was found, otherwise return `default-directory'." (let (projectile-require-project-root) (projectile-project-root))) @@ -445,7 +445,7 @@ active.") (defun doom-modeline--buffer-file-name-truncate (&optional truncate-tail) "Propertized variable `buffer-file-name' that truncates every dir along path. - If TRUNCATE-TAIL is t also truncate the parent directory of the file." +If TRUNCATE-TAIL is t also truncate the parent directory of the file." (let ((dirs (shrink-path-prompt (file-name-directory buffer-file-truename))) (active (doom-modeline--active))) (if (null dirs) @@ -771,7 +771,7 @@ lines are selected, or the NxM dimensions of a block selection." (defsubst doom-modeline--anzu () "Show the match index and total number thereof. - Requires `anzu', also `evil-anzu' if using `evil-mode' for compatibility with +Requires `anzu', also `evil-anzu' if using `evil-mode' for compatibility with `evil-search'." (setq anzu-cons-mode-line-p nil) (when (and (featurep 'anzu)