mirror of
https://github.com/correl/doom-modeline.git
synced 2024-11-23 19:19:50 +00:00
Update comments.
This commit is contained in:
parent
871f5f8115
commit
69e47314a3
1 changed files with 8 additions and 8 deletions
|
@ -62,7 +62,7 @@
|
||||||
(defvar doom-modeline-buffer-file-name-style 'truncate-upto-project
|
(defvar doom-modeline-buffer-file-name-style 'truncate-upto-project
|
||||||
"Determines the style used by `doom-modeline-buffer-file-name'.
|
"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-project => ~/P/F/emacs/lisp/comint.el
|
||||||
truncate-upto-root => ~/P/F/e/lisp/comint.el
|
truncate-upto-root => ~/P/F/e/lisp/comint.el
|
||||||
truncate-all => ~/P/F/e/l/comint.el
|
truncate-all => ~/P/F/e/l/comint.el
|
||||||
|
@ -218,10 +218,10 @@ active.")
|
||||||
(defmacro doom-modeline-def-modeline (name lhs &optional rhs)
|
(defmacro doom-modeline-def-modeline (name lhs &optional rhs)
|
||||||
"Defines a modeline format and byte-compiles it.
|
"Defines a modeline format and byte-compiles it.
|
||||||
|
|
||||||
NAME is a symbol to identify it (used by `doom-modeline' for retrieval).
|
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
|
LHS and RHS are lists of symbols of modeline segments defined with
|
||||||
`doom-modeline-def-segment'.
|
`doom-modeline-def-segment'.
|
||||||
Example:
|
Example:
|
||||||
(doom-modeline-def-modeline minimal
|
(doom-modeline-def-modeline minimal
|
||||||
(bar matches \" \" buffer-info)
|
(bar matches \" \" buffer-info)
|
||||||
(media-info major-mode))
|
(media-info major-mode))
|
||||||
|
@ -270,7 +270,7 @@ active.")
|
||||||
(defun doom-modeline-project-root ()
|
(defun doom-modeline-project-root ()
|
||||||
"Get the path to the root of your project.
|
"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'."
|
`default-directory'."
|
||||||
(let (projectile-require-project-root)
|
(let (projectile-require-project-root)
|
||||||
(projectile-project-root)))
|
(projectile-project-root)))
|
||||||
|
@ -445,7 +445,7 @@ active.")
|
||||||
(defun doom-modeline--buffer-file-name-truncate (&optional truncate-tail)
|
(defun doom-modeline--buffer-file-name-truncate (&optional truncate-tail)
|
||||||
"Propertized variable `buffer-file-name' that truncates every dir along path.
|
"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)))
|
(let ((dirs (shrink-path-prompt (file-name-directory buffer-file-truename)))
|
||||||
(active (doom-modeline--active)))
|
(active (doom-modeline--active)))
|
||||||
(if (null dirs)
|
(if (null dirs)
|
||||||
|
@ -771,7 +771,7 @@ lines are selected, or the NxM dimensions of a block selection."
|
||||||
(defsubst doom-modeline--anzu ()
|
(defsubst doom-modeline--anzu ()
|
||||||
"Show the match index and total number thereof.
|
"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'."
|
`evil-search'."
|
||||||
(setq anzu-cons-mode-line-p nil)
|
(setq anzu-cons-mode-line-p nil)
|
||||||
(when (and (featurep 'anzu)
|
(when (and (featurep 'anzu)
|
||||||
|
|
Loading…
Reference in a new issue