|
192 | 192 | (ignore-errors (jcs-modeline--light-color-p (face-background 'default)))) |
193 | 193 |
|
194 | 194 | (defun jcs-modeline-format (format &optional face window buffer) |
195 | | - "Wrapper for function `format-mode-line'." |
| 195 | + "Wrapper for function `format-mode-line'. |
| 196 | +
|
| 197 | +Arguments FORMAT, FACE, WINDOW and BUFFER are parameters from the |
| 198 | +`format-mode-line' function." |
196 | 199 | (string-trim (format-mode-line format face window buffer))) |
197 | 200 |
|
198 | 201 | (defun jcs-modeline--moody-tab (arg0 &rest _) |
199 | | - "Override `moody-ta' function when inside the terminal." |
| 202 | + "Override the function `moody-tab' when inside the terminal. |
| 203 | +
|
| 204 | +Position argument ARG0." |
200 | 205 | (concat " " arg0 " ")) |
201 | 206 |
|
202 | 207 | ;; |
@@ -373,7 +378,7 @@ mouse-1: Toggle display of major mode name" |
373 | 378 | (when-let ((current (project-current))) (project-root current))) |
374 | 379 |
|
375 | 380 | (defcustom jcs-modeline-show-project-name-virutal-buffer nil |
376 | | - "If non-nil, display project-name in virutal buffer." |
| 381 | + "If non-nil, display project's name in the virutal buffer." |
377 | 382 | :type 'boolean |
378 | 383 | :group 'jcs-modeline) |
379 | 384 |
|
@@ -481,7 +486,7 @@ mouse-1: Reveal project in folder" project) |
481 | 486 | 'help-echo "UndoTree Parent Buffer")))) |
482 | 487 |
|
483 | 488 | (defun jcs-modeline--undo-tree-branch-height (root) |
484 | | - "Return the total height of the current branch." |
| 489 | + "Return the total height of the current branch from ROOT." |
485 | 490 | (let ((count 0)) |
486 | 491 | (while (setq root (nth (undo-tree-node-branch root) |
487 | 492 | (undo-tree-node-next root))) |
@@ -532,7 +537,7 @@ mouse-1: Reveal project in folder" project) |
532 | 537 | ;;; Flymake |
533 | 538 |
|
534 | 539 | (defun jcs-modeline--flymake-lighter (diags-by-type state running) |
535 | | - "Return flycheck lighter by given STATE. |
| 540 | + "Return flycheck lighter by given DIAGS-BY-TYPE and STATE. |
536 | 541 |
|
537 | 542 | If argument RUNNING is non-nil, we turn lighter into question mark." |
538 | 543 | (let* ((c-state (cl-case state |
|
0 commit comments