phundrak/dotfiles
1
0
Fork 0
Code Issues Pull Requests Activity

[Emacs] Add documentation to undocumented functions

Browse Source
This commit is contained in:
Lucien Cartier-Tilet 2020-10-22 13:35:04 +02:00
parent 9cfa1c1ac4
commit a405eb602a
Signed by: phundrak
GPG Key ID: BD7789E705CB8DCA
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
org/config/emacs.org
View File

@ -1376,6 +1376,7 @@
first argument. Here is how it is implemented: first argument. Here is how it is implemented:
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(defmacro with-face ($str &rest $properties) (defmacro with-face ($str &rest $properties)
"Helper macro for creating strings with faces"
`(propertize ,$str 'face (list ,@$properties))) `(propertize ,$str 'face (list ,@$properties)))
#+END_SRC #+END_SRC
@ -1387,6 +1388,8 @@
~nil~ it will return the value ~value~ holds (or will return). ~nil~ it will return the value ~value~ holds (or will return).
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(defmacro phundrak/var-or-if-nil ($var &rest $value) (defmacro phundrak/var-or-if-nil ($var &rest $value)
"Return the result yield by `$value' if `$var' is `nil', return
`$var' otherwise"
`(if (null ,$var) `(if (null ,$var)
,@$value ,@$value
,$var)) ,$var))
@ -1429,6 +1432,8 @@
prompt") prompt")
(defun phundrak/prompt-toggle-abbreviation () (defun phundrak/prompt-toggle-abbreviation ()
"Toggles whether the Eshell prompt should shorten the name of
the parent directories or not. See `phundrak/eshell-prompt'"
(interactive) (interactive)
(setq phundrak/prompt--abbreviate (not phundrak/prompt--abbreviate))) (setq phundrak/prompt--abbreviate (not phundrak/prompt--abbreviate)))
#+END_SRC #+END_SRC
@ -1562,6 +1567,9 @@
be using some functions from third party packages, such as [[https://github.com/rejeep/f.el][f.el]] and [[https://github.com/magnars/dash.el][dash]]. be using some functions from third party packages, such as [[https://github.com/rejeep/f.el][f.el]] and [[https://github.com/magnars/dash.el][dash]].
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(defun phundrak/find-org-file () (defun phundrak/find-org-file ()
"Find all org files in the directories listed in
`phundrak/org-directories', then list them in a helm buffer where
the user can fuzzy-match one and open it."
(interactive) (interactive)
(find-file (find-file
(helm (helm
@ -1958,6 +1966,22 @@
with a keyboard shortcut, see [[#User_Configuration-Shortcuts-Toggle-d53c27ef][Keybindings: Toggle]]. with a keyboard shortcut, see [[#User_Configuration-Shortcuts-Toggle-d53c27ef][Keybindings: Toggle]].
#+BEGIN_SRC emacs-lisp #+BEGIN_SRC emacs-lisp
(defun eshell/my-prompt () (defun eshell/my-prompt ()
"Definition of my prompt for Eshell
It displays a powerline prompt, with first an abbreviated path to
the current directory. If `phundrak/prompt--abbreviate' is `t',
then all preceding directories will be abbreviated to one
character, except hidden directory which first character will be
preceded by a dot. Otherwise, the full name of the directories is
displayed.
Then, if the current directory is a git repository or one of its
subdirectories, it will display the current state of the
repository. See `phundrak/eshell-git-status'
Finally, a lambda character is displayed, either in blue or in
red depending on if the last eshell command was a success or a
failure respectively."
(let* ((header-bg phundrak/nord0) (let* ((header-bg phundrak/nord0)
($path (phundrak/abbr-pwd)) ($path (phundrak/abbr-pwd))
($abbr-path (phundrak/abbr-pwd phundrak/prompt--abbreviate)) ($abbr-path (phundrak/abbr-pwd phundrak/prompt--abbreviate))