diff options
| author | Manuel Uberti <manuel.uberti@inventati.org> | 2020-06-01 15:33:56 +0200 |
|---|---|---|
| committer | Manuel Uberti <manuel.uberti@inventati.org> | 2020-06-03 11:06:21 +0200 |
| commit | 5cf79283d605f3520da434f46fefa82943f2eddd (patch) | |
| tree | 256e2a04b101ebcbaf2908918f83e51684b1e308 /helm-eshell.el | |
| parent | 130175735fb9c55f9e2a2c1a7d2609d628458f77 (diff) | |
Fix documentation
Diffstat (limited to 'helm-eshell.el')
| -rw-r--r-- | helm-eshell.el | 15 |
1 files changed, 8 insertions, 7 deletions
diff --git a/helm-eshell.el b/helm-eshell.el index 837c70ed..4d929b4c 100644 --- a/helm-eshell.el +++ b/helm-eshell.el @@ -44,12 +44,12 @@ (defgroup helm-eshell nil - "Helm eshell completion and history." + "Helm completion and history for Eshell." :group 'helm) (defcustom helm-eshell-fuzzy-match nil - "Enable fuzzy matching in `helm-esh-pcomplete' when non--nil." + "Enable fuzzy matching in `helm-esh-pcomplete' when non-nil." :group 'helm-eshell :type 'boolean) @@ -75,7 +75,8 @@ (defvar helm-ec-target "") (defun helm-ec-insert (_candidate) "Replace text at point with CANDIDATE. -The function that call this should set `helm-ec-target' to thing at point." +The function that call this should set `helm-ec-target' to thing +at point." (set (make-local-variable 'comint-file-name-quote-list) eshell-special-chars-outside-quoting) (let ((pt (point))) @@ -133,7 +134,7 @@ The function that call this should set `helm-ec-target' to thing at point." "Helm class to define source for Eshell completion.") (defun helm-esh-get-candidates () - "Get candidates for eshell completion using `pcomplete'." + "Get candidates for Eshell completion using `pcomplete'." (catch 'pcompleted (with-helm-current-buffer (let* ((pcomplete-stub) @@ -251,7 +252,7 @@ The function that call this should set `helm-ec-target' to thing at point." ;;;###autoload (defun helm-esh-pcomplete () - "Preconfigured helm to provide helm completion in eshell." + "Preconfigured `helm' to provide Helm completion in Eshell." (interactive) (let* ((helm-quit-if-no-candidate t) (helm-execute-action-at-once-if-one t) @@ -332,7 +333,7 @@ The function that call this should set `helm-ec-target' to thing at point." ;;;###autoload (defun helm-eshell-history () - "Preconfigured helm for eshell history." + "Preconfigured Helm for Eshell history." (interactive) (let* ((end (point)) (beg (save-excursion (eshell-bol) (point))) @@ -387,7 +388,7 @@ The function that call this should set `helm-ec-target' to thing at point." "List the prompts in Eshell BUFFER. Return a list of (\"prompt\" (point) (buffer-name) prompt-index)) -e.g. (\"ls\" 162 \"*eshell*\" 3). +E.g. (\"ls\" 162 \"*eshell*\" 3). If BUFFER is nil, use current buffer." (with-current-buffer (or buffer (current-buffer)) (when (eq major-mode 'eshell-mode) |