summaryrefslogtreecommitdiff
path: root/helm-help.el
diff options
context:
space:
mode:
authorThierry Volpiatto <thierry.volpiatto@gmail.com>2017-09-20 15:12:24 +0200
committerThierry Volpiatto <thierry.volpiatto@gmail.com>2017-09-20 15:12:24 +0200
commita3b88e3d20d3d9af39f00e61a73e7d51937c1826 (patch)
tree504263f27860133c3f39a1e827b2b4f2fb481438 /helm-help.el
parent36f4e6fa4f00c426fe55778c23657474d7a559f2 (diff)
Add help for completing-read's
* helm-help.el (helm-ff-help-message): Unrelated fix typo. (helm-comp-read-help-message): New (it is a function). * helm-mode.el (helm-completing-read-default-1): Use it.
Diffstat (limited to 'helm-help.el')
-rw-r--r--helm-help.el30
1 files changed, 29 insertions, 1 deletions
diff --git a/helm-help.el b/helm-help.el
index e6d992f2..d30f1b1b 100644
--- a/helm-help.el
+++ b/helm-help.el
@@ -256,7 +256,7 @@ It behaves differently depending on `helm-selection' (current candidate in helm-
Note that when copying, renaming, etc. from `helm-find-files' the
destination file is selected with `helm-read-file-name'.
-To void confusion when using `read-file-name' or `read-directory-name', `RET'
+To avoid confusion when using `read-file-name' or `read-directory-name', `RET'
follows its standard Emacs behaviour, i.e. it exits the minibuffer as soon as
you press `RET'. If you want the same behavior as in `helm-find-files', bind
`helm-ff-RET' to the `helm-read-file-map':
@@ -1510,6 +1510,34 @@ actions menu.
\\[helm-org-run-refile-heading-to]\t\tRefile current or marked headings to selection.
\\[helm-org-run-insert-link-to-heading-at-marker]\t\tInsert link at point to selection."
)
+
+;;; Completing-read
+;;
+(defun helm-comp-read-help-message ()
+ (let ((com (assoc-default 'name (helm-get-current-source))))
+ (format
+ "* Helm completing-read completion for `%s'
+
+Command `%s' is using a `completing-read' for completion on your input,
+this completion have been \"helmized\" because you have enabled `helm-mode'.
+
+** Tips
+
+*** Disabling or use something else than helm for completion of some commands
+
+You can disable helm completion or use something else for specific commands of your choice,
+for this customize variable `helm-completing-read-handlers-alist'.
+
+*** Exiting minibuffer with empty string
+
+You can exit minibuffer with empty string with \\<helm-comp-read-map>\\[helm-cr-empty-string].
+It is useful when some commands are prompting continuously until you enter an empty prompt.
+
+** Commands
+\\<helm-comp-read-map>
+\\[helm-cr-empty-string]\t\tExit minibuffer with empty string."
+ com com)))
+
;;; Mode line strings
;;