Improve functions documentation

This commit is contained in:
Lucien Cartier-Tilet 2022-01-07 02:03:44 +01:00
parent d145705a61
commit f9113b7a35
Signed by: phundrak
GPG Key ID: BD7789E705CB8DCA
1 changed files with 5 additions and 1 deletions

View File

@ -237,7 +237,9 @@ Ensures the command is ran with LANG=C."
"Display a progress bar without its prefix. "Display a progress bar without its prefix.
Display a progress bar of BAR-LENGTH length, followed by an Display a progress bar of BAR-LENGTH length, followed by an
indication of how full the memory is with a human readable USED indication of how full the memory is with a human readable USED
and TOTAL size." and TOTAL size.
Optional argument NEWLINE: Whether to output a newline at the end
of the progress bar."
(let ((percentage (if (= used 0) (let ((percentage (if (= used 0)
0 0
(/ (* 100 used) total)))) (/ (* 100 used) total))))
@ -468,6 +470,8 @@ For TEXT-PADDING and BAR-LENGTH, see the documentation of
t))) t)))
(defun eshell-info-banner--get-memory-unix-command-to-mem (command) (defun eshell-info-banner--get-memory-unix-command-to-mem (command)
"Get the output of COMMAND corresponding to memory information.
This function is to be only used on platforms which support sysctl."
(string-to-number (string-to-number
(s-trim (s-trim
(car (last (car (last