summaryrefslogtreecommitdiff
path: root/helm-lib.el
diff options
context:
space:
mode:
authorThierry Volpiatto <thierry.volpiatto@gmail.com>2020-07-26 11:40:35 +0200
committerThierry Volpiatto <thierry.volpiatto@gmail.com>2020-07-26 11:43:42 +0200
commit54a5e4cd7a10b2c285dc5bfe9dc100629b5d8b99 (patch)
treed31f8fb6e6e68d6611e9fa92f207decaad7bb010 /helm-lib.el
parent48bb48063a74e5f2a355fbeae81fb97114840bdc (diff)
Add docstrings in help fns
Diffstat (limited to 'helm-lib.el')
-rw-r--r--helm-lib.el11
1 files changed, 11 insertions, 0 deletions
diff --git a/helm-lib.el b/helm-lib.el
index 79fcbb5e..9cdb96b0 100644
--- a/helm-lib.el
+++ b/helm-lib.el
@@ -635,56 +635,67 @@ displayed in BUFNAME."
(set-frame-configuration winconf)))))
(cl-defun helm-help-scroll-up (&optional (amount helm-scroll-amount))
+ "Scroll up in `helm-help'."
(condition-case _err
(scroll-up-command amount)
(beginning-of-buffer nil)
(end-of-buffer nil)))
(cl-defun helm-help-scroll-down (&optional (amount helm-scroll-amount))
+ "Scroll down in `helm-help'."
(condition-case _err
(scroll-down-command amount)
(beginning-of-buffer nil)
(end-of-buffer nil)))
(defun helm-help-next-line ()
+ "Next line function for `helm-help'."
(condition-case _err
(call-interactively #'next-line)
(beginning-of-buffer nil)
(end-of-buffer nil)))
(defun helm-help-previous-line ()
+ "Previous line function for `helm-help'."
(condition-case _err
(call-interactively #'previous-line)
(beginning-of-buffer nil)
(end-of-buffer nil)))
(defun helm-help-toggle-mark ()
+ "Toggle mark in `helm-help'."
(if (region-active-p)
(deactivate-mark)
(push-mark nil nil t)))
(defun helm-help-org-cycle ()
+ "Runs `org-cycle' in `helm-help'."
(pcase (helm-iter-next helm-help--iter-org-state)
((pred numberp) (org-content))
((and state) (org-cycle state))))
(defun helm-help-copy-region-as-kill ()
+ "Copy region function for `helm-help'"
(copy-region-as-kill
(region-beginning) (region-end))
(deactivate-mark))
(defun helm-help-quit ()
+ "Quit `helm-help'."
(throw 'helm-help-quit nil))
(defun helm-help-org-open-at-point ()
+ "Calls `org-open-at-point' ignoring errors."
(ignore-errors
(org-open-at-point)))
(defun helm-help-org-mark-ring-goto ()
+ "Calls `org-mark-ring-goto' ignoring errors."
(ignore-errors
(org-mark-ring-goto)))
(defun helm-help-event-loop ()
+ "The loop in charge of scanning keybindings in `helm-help'."
(let ((prompt (propertize
helm-help-default-prompt
'face 'helm-helper))