[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[nongnu] elpa/helm 7adca3d2cf 1/2: Revert "Fix unquoted single quotes in
|
From: |
ELPA Syncer |
|
Subject: |
[nongnu] elpa/helm 7adca3d2cf 1/2: Revert "Fix unquoted single quotes in docstrings" |
|
Date: |
Tue, 7 Jun 2022 08:58:34 -0400 (EDT) |
branch: elpa/helm
commit 7adca3d2cf338540feb606a9ced3c67b6938155c
Author: Thierry Volpiatto <thievol@posteo.net>
Commit: Thierry Volpiatto <thievol@posteo.net>
Revert "Fix unquoted single quotes in docstrings"
This reverts commit 8387864d5a4e7393b0657d07ba2ce391de7bed21.
---
helm-adaptive.el | 14 +-
helm-bookmark.el | 40 +-
helm-buffers.el | 96 ++---
helm-color.el | 12 +-
helm-comint.el | 16 +-
helm-command.el | 56 +--
helm-core.el | 958 ++++++++++++++++++++++++------------------------
helm-dabbrev.el | 48 +--
helm-elisp-package.el | 8 +-
helm-elisp.el | 52 +--
helm-epa.el | 12 +-
helm-eshell.el | 20 +-
helm-eval.el | 8 +-
helm-external.el | 22 +-
helm-files.el | 636 ++++++++++++++++----------------
helm-find.el | 8 +-
helm-font.el | 16 +-
helm-for-files.el | 22 +-
helm-global-bindings.el | 2 +-
helm-grep.el | 140 +++----
helm-help.el | 8 +-
helm-id-utils.el | 18 +-
helm-imenu.el | 34 +-
helm-info.el | 32 +-
helm-lib.el | 262 ++++++-------
helm-locate.el | 52 +--
helm-man.el | 6 +-
helm-misc.el | 22 +-
helm-mode.el | 376 +++++++++----------
helm-multi-match.el | 32 +-
helm-net.el | 32 +-
helm-occur.el | 80 ++--
helm-regexp.el | 10 +-
helm-ring.el | 38 +-
helm-semantic.el | 24 +-
helm-source.el | 292 +++++++--------
helm-sys.el | 40 +-
helm-tags.el | 30 +-
helm-utils.el | 122 +++---
helm-x-files.el | 6 +-
40 files changed, 1851 insertions(+), 1851 deletions(-)
diff --git a/helm-adaptive.el b/helm-adaptive.el
index 67023a6c38..69b616f9c1 100644
--- a/helm-adaptive.el
+++ b/helm-adaptive.el
@@ -32,7 +32,7 @@
(locate-user-emacs-file "helm-adaptive-history")
"Path of file where history information is stored.
When nil history is not saved nor restored after Emacs restart
-unless you save/restore `helm-adaptive-history\\=' with something
+unless you save/restore `helm-adaptive-history' with something
else like psession or desktop."
:type 'string
:group 'helm-adapt)
@@ -166,14 +166,14 @@ Format: ((SOURCE-NAME
(cl-subseq (cdr selection-info) 0
helm-adaptive-history-length))))))))
(defun helm-adaptive-maybe-load-history ()
- "Load `helm-adaptive-history-file\\=' which contain
`helm-adaptive-history\\='.
-Returns nil if `helm-adaptive-history-file\\=' doesn\\='t exist."
+ "Load `helm-adaptive-history-file' which contain `helm-adaptive-history'.
+Returns nil if `helm-adaptive-history-file' doesn't exist."
(when (and helm-adaptive-history-file
(file-readable-p helm-adaptive-history-file))
(load-file helm-adaptive-history-file)))
(defun helm-adaptive-save-history (&optional arg)
- "Save history information to the file given by
`helm-adaptive-history-file\\='."
+ "Save history information to the file given by `helm-adaptive-history-file'."
(interactive "p")
(when helm-adaptive-history-file
(with-temp-buffer
@@ -190,7 +190,7 @@ Returns nil if `helm-adaptive-history-file\\=' doesn\\='t
exist."
(defun helm-adaptive-sort (candidates source)
"Sort the CANDIDATES for SOURCE by usage frequency.
This is a filtered candidate transformer you can use with the
-`filtered-candidate-transformer\\=' attribute."
+`filtered-candidate-transformer' attribute."
(let* ((source-name (assoc-default 'name source))
(source-info (assoc source-name helm-adaptive-history)))
(if source-info
@@ -265,9 +265,9 @@ you should reinitialize it with
`helm-reset-adaptive-history'"
;;;###autoload
(defun helm-reset-adaptive-history ()
- "Delete all `helm-adaptive-history\\=' and his file.
+ "Delete all `helm-adaptive-history' and his file.
Useful when you have a old or corrupted
-`helm-adaptive-history-file\\='."
+`helm-adaptive-history-file'."
(interactive)
(when (y-or-n-p "Really delete all your `helm-adaptive-history'? ")
(setq helm-adaptive-history nil)
diff --git a/helm-bookmark.el b/helm-bookmark.el
index 239c82c708..1fad3a517d 100644
--- a/helm-bookmark.el
+++ b/helm-bookmark.el
@@ -35,7 +35,7 @@
(defgroup helm-bookmark nil
- "Predefined configurations for `helm.el\\='."
+ "Predefined configurations for `helm.el'."
:group 'helm)
(defcustom helm-bookmark-show-location nil
@@ -55,12 +55,12 @@
helm-source-bookmark-w3m)
(list 'helm-source-bookmark-uncategorized
'helm-source-bookmark-set))
- "List of sources to use in `helm-filtered-bookmarks\\='."
+ "List of sources to use in `helm-filtered-bookmarks'."
:group 'helm-bookmark
:type '(repeat (choice symbol)))
(defcustom helm-bookmark-use-icon nil
- "Display candidates with an icon with `all-the-icons\\=' when non nil."
+ "Display candidates with an icon with `all-the-icons' when non nil."
:type 'boolean
:group 'helm-bookmark)
@@ -208,7 +208,7 @@
;;; Predicates
;;
(defconst helm-bookmark--non-file-filename " - no file -"
- "Name to use for `filename\\=' entry, for non-file bookmarks.")
+ "Name to use for `filename' entry, for non-file bookmarks.")
(defun helm-bookmark-gnus-bookmark-p (bookmark)
"Return non-nil if BOOKMARK is a Gnus bookmark.
@@ -274,7 +274,7 @@ This excludes bookmarks of a more specific kind (Info,
Gnus, and W3m)."
(string-suffix-p ".org_archive" filename t))))
(defun helm-bookmark-helm-find-files-p (bookmark)
- "Return non-nil if BOOKMARK bookmarks a `helm-find-files\\=' session.
+ "Return non-nil if BOOKMARK bookmarks a `helm-find-files' session.
BOOKMARK is a bookmark name or a bookmark record."
(eq (bookmark-get-handler bookmark) 'helm-ff-bookmark-jump))
@@ -302,7 +302,7 @@ BOOKMARK is a bookmark name or a bookmark record."
never (funcall pred bookmark)))
(defun helm-bookmark-filter-setup-alist (fn)
- "Return a filtered `bookmark-alist\\=' sorted alphabetically."
+ "Return a filtered `bookmark-alist' sorted alphabetically."
(cl-loop for b in bookmark-alist
for name = (car b)
when (funcall fn b) collect
@@ -313,8 +313,8 @@ BOOKMARK is a bookmark name or a bookmark record."
(defvar w3m-async-exec)
(defun helm-bookmark-jump-w3m (bookmark)
"Jump to W3m bookmark BOOKMARK, setting a new tab.
-If `browse-url-browser-function\\=' is set to something else than
-`w3m-browse-url\\=' use it."
+If `browse-url-browser-function' is set to something else than
+`w3m-browse-url' use it."
(require 'helm-net)
(let* ((file (or (bookmark-prop-get bookmark 'filename)
(bookmark-prop-get bookmark 'url)))
@@ -476,17 +476,17 @@ If `browse-url-browser-function\\=' is set to something
else than
;;; Helm find files sessions.
;;
(defun helm-bookmark-helm-find-files-setup-alist ()
- "Specialized filter function for `helm-find-files\\=' bookmarks."
+ "Specialized filter function for `helm-find-files' bookmarks."
(helm-bookmark-filter-setup-alist 'helm-bookmark-helm-find-files-p))
(defun helm-bookmark-browse-project (candidate)
- "Run `helm-browse-project\\=' from action."
+ "Run `helm-browse-project' from action."
(with-helm-default-directory
(bookmark-get-filename candidate)
(helm-browse-project nil)))
(defun helm-bookmark-run-browse-project ()
- "Run `helm-bookmark-browse-project\\=' from keyboard."
+ "Run `helm-bookmark-browse-project' from keyboard."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-bookmark-browse-project)))
@@ -542,7 +542,7 @@ If `browse-url-browser-function\\=' is set to something
else than
;;
(defun helm-highlight-bookmark (bookmarks _source)
- "Used as `filtered-candidate-transformer\\=' to colorize bookmarks."
+ "Used as `filtered-candidate-transformer' to colorize bookmarks."
(let ((non-essential t))
(cl-loop for i in bookmarks
for isfile = (bookmark-get-filename i)
@@ -656,7 +656,7 @@ If `browse-url-browser-function\\=' is set to something
else than
;;
;;
(defun helm-bookmark-edit-bookmark (bookmark-name)
- "Edit bookmark\\='s name and file name, and maybe save them.
+ "Edit bookmark's name and file name, and maybe save them.
BOOKMARK-NAME is the current (old) name of the bookmark to be
renamed."
(let ((bmk (helm-bookmark-get-bookmark-from-name bookmark-name))
@@ -693,12 +693,12 @@ renamed."
(list new-name new-loc))))
(defun helm-bookmark-maybe-save-bookmark ()
- "Increment save counter and maybe save `bookmark-alist\\='."
+ "Increment save counter and maybe save `bookmark-alist'."
(setq bookmark-alist-modification-count (1+
bookmark-alist-modification-count))
(when (bookmark-time-to-save-p) (bookmark-save)))
(defun helm-bookmark-rename (old &optional new batch)
- "Change bookmark\\='s name from OLD to NEW.
+ "Change bookmark's name from OLD to NEW.
Interactively:
If called from the keyboard, then prompt for OLD.
If called from the menubar, select OLD from a menu.
@@ -706,7 +706,7 @@ If NEW is nil, then prompt for its string value.
If BATCH is non-nil, then do not rebuild the menu list.
-While the user enters the new name, repeated `C-w\\=' inserts
+While the user enters the new name, repeated `C-w' inserts
consecutive words from the buffer into the new bookmark name."
(interactive (list (bookmark-completing-read "Old bookmark name")))
(bookmark-maybe-historicize-string old)
@@ -725,7 +725,7 @@ consecutive words from the buffer into the new bookmark
name."
(helm-bookmark-maybe-save-bookmark) newname))
(defun helm-bookmark-run-edit ()
- "Run `helm-bookmark-edit-bookmark\\=' from keyboard."
+ "Run `helm-bookmark-edit-bookmark' from keyboard."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-bookmark-edit-bookmark)))
@@ -769,7 +769,7 @@ E.g. prepended with *."
;;;###autoload
(defun helm-bookmarks ()
- "Preconfigured `helm\\=' for bookmarks."
+ "Preconfigured `helm' for bookmarks."
(interactive)
(helm :sources '(helm-source-bookmarks
helm-source-bookmark-set)
@@ -778,8 +778,8 @@ E.g. prepended with *."
;;;###autoload
(defun helm-filtered-bookmarks ()
- "Preconfigured `helm\\=' for bookmarks (filtered by category).
-Optional source `helm-source-bookmark-addressbook\\=' is loaded only
+ "Preconfigured `helm' for bookmarks (filtered by category).
+Optional source `helm-source-bookmark-addressbook' is loaded only
if external addressbook-bookmark package is installed."
(interactive)
(when helm-bookmark-use-icon
diff --git a/helm-buffers.el b/helm-buffers.el
index b921c3693e..2db8a09dd1 100644
--- a/helm-buffers.el
+++ b/helm-buffers.el
@@ -42,14 +42,14 @@
"The regexp list that match boring buffers.
Buffer candidates matching these regular expression will be
filtered from the list of candidates if the
-`helm-skip-boring-buffers\\=' candidate transformer is used."
+`helm-skip-boring-buffers' candidate transformer is used."
:type '(repeat (choice regexp))
:group 'helm-buffers)
(defcustom helm-white-buffer-regexp-list nil
"The regexp list of not boring buffers.
These buffers will be displayed even if they match one of
-`helm-boring-buffer-regexp-list\\='."
+`helm-boring-buffer-regexp-list'."
:type '(repeat (choice regexp))
:group 'helm-buffers)
@@ -63,7 +63,7 @@ These buffers will be displayed even if they match one of
(defcustom helm-buffer-max-length 20
"Max length of buffer names before truncate.
-When disabled (nil) use the longest `buffer-name\\=' length found."
+When disabled (nil) use the longest `buffer-name' length found."
:group 'helm-buffers
:type '(choice (const :tag "Disabled" nil)
(integer :tag "Length before truncate")))
@@ -76,29 +76,29 @@ When disabled (nil) use the longest `buffer-name\\=' length
found."
(defcustom helm-buffers-fuzzy-matching nil
"Fuzzy matching buffer names when non-nil.
Only buffer names are fuzzy matched when this is enabled,
-`major-mode\\=' matching is not affected by this."
+`major-mode' matching is not affected by this."
:group 'helm-buffers
:type 'boolean)
(defcustom helm-buffer-skip-remote-checking nil
- "Ignore checking for `file-exists-p\\=' on remote files."
+ "Ignore checking for `file-exists-p' on remote files."
:group 'helm-buffers
:type 'boolean)
(defcustom helm-buffers-truncate-lines t
- "Truncate lines in `helm-buffers-list\\=' when non-nil."
+ "Truncate lines in `helm-buffers-list' when non-nil."
:group 'helm-buffers
:type 'boolean)
(defcustom helm-buffers-left-margin-width helm-left-margin-width
- "`left-margin-width\\=' value for `helm-mini\\=' and `helm-buffers-list\\='."
+ "`left-margin-width' value for `helm-mini' and `helm-buffers-list'."
:group 'helm-buffers
:type 'integer)
(defcustom helm-mini-default-sources '(helm-source-buffers-list
helm-source-recentf
helm-source-buffer-not-found)
- "Default sources list used in `helm-mini\\='.
+ "Default sources list used in `helm-mini'.
When adding a source here it is up to you to ensure the library
of this source is accessible and properly loaded."
@@ -118,7 +118,7 @@ of this source is accessible and properly loaded."
(defcustom helm-buffer--pretty-names '((dired-mode . "Dired")
(lisp-interaction-mode . "Lisp Inter"))
"An alist specifying pretty names for modes.
-Most of the time buffer\\='s `mode-name\\=' is a string so no need to
+Most of the time buffer's `mode-name' is a string so no need to
add it here as there is no need to compute it, but sometimes it
may be a mode-line specification which may be costly to compute,
in this case add here the pretty name as a string to avoid this
@@ -129,7 +129,7 @@ can add your own abbreviation here."
(defcustom helm-buffers-maybe-switch-to-tab nil
"Switch to buffer in its tab when non nil.
-This has no effect when `tab-bar-mode\\=' is not available."
+This has no effect when `tab-bar-mode' is not available."
:group 'helm-buffers
:type 'boolean)
@@ -141,15 +141,15 @@ Arg OTHERS handles all the other buffers.
You can write a function that reorder VISIBLES and OTHERS as you
want.
Default function returns OTHERS buffers on top and VISIBLES
-buffer at the end. See `helm-buffers-reorder-buffer-list\\='."
+buffer at the end. See `helm-buffers-reorder-buffer-list'."
:group 'helm-buffers
:type 'function)
(defcustom helm-buffers-sort-fn helm-fuzzy-sort-fn
- "The sort function to use in `helm-buffers-list\\='.
+ "The sort function to use in `helm-buffers-list'.
-Default to `helm-fuzzy-sort-fn\\=' you can use
-`helm-fuzzy-matching-sort-fn-preserve-ties-order\\=' as alternative if
+Default to `helm-fuzzy-sort-fn' you can use
+`helm-fuzzy-matching-sort-fn-preserve-ties-order' as alternative if
you want to keep the recentest order when narrowing candidates."
:type 'function
:group 'helm-buffers)
@@ -206,25 +206,25 @@ you want to keep the recentest order when narrowing
candidates."
(defface helm-buffer-directory
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "DarkRed" :background "LightGray"))
- "Face used for directories in `helm-buffers-list\\='."
+ "Face used for directories in `helm-buffers-list'."
:group 'helm-buffers-faces)
(defface helm-buffer-file
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:inherit font-lock-builtin-face))
- "Face for buffer file names in `helm-buffers-list\\='."
+ "Face for buffer file names in `helm-buffers-list'."
:group 'helm-buffers-faces)
(defface helm-buffer-archive
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "Gold"))
- "Face for archive file names in `helm-buffers-list\\='."
+ "Face for archive file names in `helm-buffers-list'."
:group 'helm-buffers-faces)
(defface helm-non-file-buffer
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:inherit italic))
- "Face used for non-file buffers in `helm-buffers-list\\='."
+ "Face used for non-file buffers in `helm-buffers-list'."
:group 'helm-buffers-faces)
(defvar helm-buffers-tick-counter nil
@@ -371,7 +371,7 @@ Note that this variable is buffer-local.")
(define-key map (kbd "C-c o") 'helm-buffers-not-found-run-switch-ow)
(define-key map (kbd "C-c C-o") 'helm-buffers-not-found-run-switch-of)
map)
- "Keymap for `helm-source-buffer-not-found\\=' source.")
+ "Keymap for `helm-source-buffer-not-found' source.")
(defvar helm-source-buffer-not-found
(helm-build-dummy-source
@@ -411,7 +411,7 @@ at the end."
(defun helm-buffer-list ()
"Return the current list of buffers.
-The list is reordered with `helm-buffer-list-reorder-fn\\='."
+The list is reordered with `helm-buffer-list-reorder-fn'."
(let* ((visibles (helm-buffers-get-visible-buffers))
(others (helm-buffer-list-1 visibles)))
(funcall helm-buffer-list-reorder-fn visibles others)))
@@ -454,7 +454,7 @@ The list is reordered with
`helm-buffer-list-reorder-fn\\='."
'face face2)))))
(defun helm-buffer--format-mode-name (buf)
- "Prevent using `format-mode-line\\=' as much as possible."
+ "Prevent using `format-mode-line' as much as possible."
(with-current-buffer buf
(helm-acond ((assq major-mode helm-buffer--pretty-names)
(cdr it))
@@ -650,7 +650,7 @@ buffers)."
(set-window-margins (selected-window) 1)))))
(defun helm-buffers-mark-similar-buffers ()
- "Mark All buffers that have same property `type\\=' than current.
+ "Mark All buffers that have same property `type' than current.
I.e. same color."
(interactive)
(with-helm-alive-p
@@ -775,7 +775,7 @@ I.e. same color."
(defun helm-buffer-query-replace-1 (&optional regexp-flag buffers)
"Query replace in marked buffers.
-If REGEXP-FLAG is given use `query-replace-regexp\\='."
+If REGEXP-FLAG is given use `query-replace-regexp'."
(let ((prompt (if regexp-flag "Query replace regexp" "Query replace"))
(bufs (or buffers (helm-marked-candidates)))
(helm--reading-passwd-or-string t))
@@ -799,7 +799,7 @@ If REGEXP-FLAG is given use `query-replace-regexp\\='."
(helm-buffer-query-replace-1))
(defun helm-buffer-toggle-diff (candidate)
- "Toggle diff buffer CANDIDATE with it\\='s file."
+ "Toggle diff buffer CANDIDATE with it's file."
(helm-aif (get-buffer-window "*Diff*" 'visible)
(progn (kill-buffer "*Diff*")
(set-window-buffer it helm-current-buffer))
@@ -879,7 +879,7 @@ If REGEXP-FLAG is given use `query-replace-regexp\\='."
(rename-buffer (helm-read-string "New name: " (buffer-name)) t)))
(defun helm-buffer-run-rename-buffer ()
- "Run rename buffer action from `helm-source-buffers-list\\='."
+ "Run rename buffer action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-buffers-rename-buffer)))
@@ -919,42 +919,42 @@ If REGEXP-FLAG is given use `query-replace-regexp\\='."
(message "Killed %s buffer(s)" killed-bufs)))
(defun helm-buffer-run-kill-buffers ()
- "Run kill buffer action from `helm-source-buffers-list\\='."
+ "Run kill buffer action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-kill-marked-buffers)))
(put 'helm-buffer-run-kill-buffers 'helm-only t)
(defun helm-buffer-run-grep ()
- "Run Grep action from `helm-source-buffers-list\\='."
+ "Run Grep action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-grep-buffers)))
(put 'helm-buffer-run-grep 'helm-only t)
(defun helm-buffer-run-zgrep ()
- "Run Grep action from `helm-source-buffers-list\\='."
+ "Run Grep action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-zgrep-buffers)))
(put 'helm-buffer-run-zgrep 'helm-only t)
(defun helm-buffer-run-query-replace-regexp ()
- "Run Query replace regexp action from `helm-source-buffers-list\\='."
+ "Run Query replace regexp action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-buffer-query-replace-regexp)))
(put 'helm-buffer-run-query-replace-regexp 'helm-only t)
(defun helm-buffer-run-query-replace ()
- "Run Query replace action from `helm-source-buffers-list\\='."
+ "Run Query replace action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-buffer-query-replace)))
(put 'helm-buffer-run-query-replace 'helm-only t)
(defun helm-buffer-switch-other-window ()
- "Run switch to other window action from `helm-source-buffers-list\\='."
+ "Run switch to other window action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-buffer-switch-buffers-other-window)))
@@ -967,7 +967,7 @@ If REGEXP-FLAG is given use `query-replace-regexp\\='."
(helm-window-show-buffers bufs)))
(defun helm-buffer-switch-other-frame ()
- "Run switch to other frame action from `helm-source-buffers-list\\='."
+ "Run switch to other frame action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-buffer-switch-to-buffer-other-frame)))
@@ -980,7 +980,7 @@ If REGEXP-FLAG is given use `query-replace-regexp\\='."
do (switch-to-buffer-other-tab buf)))))
(defun helm-buffers-switch-to-buffer-new-tab ()
- "Run switch to buffer in other tab action from
`helm-source-buffers-list\\='."
+ "Run switch to buffer in other tab action from `helm-source-buffers-list'."
(interactive)
(cl-assert (fboundp 'tab-bar-mode) nil "Tab-bar-mode not available")
(with-helm-alive-p
@@ -1002,14 +1002,14 @@ vertically."
(helm-window-show-buffers buffers t)))
(defun helm-buffer-run-ediff ()
- "Run ediff action from `helm-source-buffers-list\\='."
+ "Run ediff action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ediff-marked-buffers)))
(put 'helm-buffer-run-ediff 'helm-only t)
(defun helm-buffer-run-ediff-merge ()
- "Run ediff action from `helm-source-buffers-list\\='."
+ "Run ediff action from `helm-source-buffers-list'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ediff-marked-buffers-merge)))
@@ -1077,8 +1077,8 @@ vertically."
(switch-to-buffer helm-current-buffer)))))
(defun helm-ediff-marked-buffers (_candidate &optional merge)
- "Ediff 2 marked buffers or CANDIDATE and `helm-current-buffer\\='.
-With optional arg MERGE call `ediff-merge-buffers\\='."
+ "Ediff 2 marked buffers or CANDIDATE and `helm-current-buffer'.
+With optional arg MERGE call `ediff-merge-buffers'."
(let* ((mkd (helm-marked-candidates))
(lg-lst (length mkd))
buf1 buf2)
@@ -1098,12 +1098,12 @@ With optional arg MERGE call `ediff-merge-buffers\\='."
(ediff-buffers buf1 buf2))))
(defun helm-ediff-marked-buffers-merge (candidate)
- "Ediff merge `helm-current-buffer\\=' with CANDIDATE.
-See `helm-ediff-marked-buffers\\='."
+ "Ediff merge `helm-current-buffer' with CANDIDATE.
+See `helm-ediff-marked-buffers'."
(helm-ediff-marked-buffers candidate t))
(defun helm-multi-occur-as-action (_candidate)
- "Multi occur action for `helm-source-buffers-list\\='.
+ "Multi occur action for `helm-source-buffers-list'.
Can be used by any source that list buffers."
(let ((helm-occur-always-search-in-current
(if helm-current-prefix-arg
@@ -1120,7 +1120,7 @@ Can be used by any source that list buffers."
(helm-multi-occur-1 buffers input)))
(defun helm-buffers-run-occur ()
- "Run `helm-multi-occur-as-action\\=' by key."
+ "Run `helm-multi-occur-as-action' by key."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-multi-occur-as-action)))
@@ -1152,7 +1152,7 @@ Can be used by any source that list buffers."
(helm-browse-project helm-current-prefix-arg)))
(defun helm-buffers-run-browse-project ()
- "Run `helm-buffers-browse-project\\=' from key."
+ "Run `helm-buffers-browse-project' from key."
(interactive)
(with-helm-alive-p
(if helm-buffers-in-project-p
@@ -1178,21 +1178,21 @@ Can be used by any source that list buffers."
;;
;;
(defun helm-skip-boring-buffers (buffers _source)
- "Remove buffers matching `helm-boring-buffer-regexp-list\\=' in BUFFERS.
+ "Remove buffers matching `helm-boring-buffer-regexp-list' in BUFFERS.
Where BUFFERS is a list of buffer names."
(helm-skip-entries buffers
helm-boring-buffer-regexp-list
helm-white-buffer-regexp-list))
(defun helm-shadow-boring-buffers (buffers _source)
- "Buffers matching `helm-boring-buffer-regexp\\=' will be
-displayed with the `file-name-shadow\\=' face if available."
+ "Buffers matching `helm-boring-buffer-regexp' will be
+displayed with the `file-name-shadow' face if available."
(helm-shadow-entries buffers helm-boring-buffer-regexp-list))
;;;###autoload
(defun helm-buffers-list ()
- "Preconfigured `helm\\=' to list buffers."
+ "Preconfigured `helm' to list buffers."
(interactive)
(unless helm-source-buffers-list
(setq helm-source-buffers-list
@@ -1206,7 +1206,7 @@ displayed with the `file-name-shadow\\=' face if
available."
;;;###autoload
(defun helm-mini ()
- "Preconfigured `helm\\=' displaying `helm-mini-default-sources\\='."
+ "Preconfigured `helm' displaying `helm-mini-default-sources'."
(interactive)
(require 'helm-x-files)
(unless helm-source-buffers-list
@@ -1219,7 +1219,7 @@ displayed with the `file-name-shadow\\=' face if
available."
:left-margin-width helm-buffers-left-margin-width))
(defun helm-quit-and-helm-mini ()
- "Drop into `helm-mini\\=' from `helm\\='."
+ "Drop into `helm-mini' from `helm'."
(interactive)
(with-helm-alive-p
(helm-run-after-exit 'helm-mini)))
diff --git a/helm-color.el b/helm-color.el
index b2de620f53..639c3ec75a 100644
--- a/helm-color.el
+++ b/helm-color.el
@@ -27,7 +27,7 @@
;;
;;
(defun helm-custom-faces-init ()
- "Initialize buffer for `helm-source-customize-face\\='."
+ "Initialize buffer for `helm-source-customize-face'."
(unless (helm-candidate-buffer)
(save-selected-window
(list-faces-display)
@@ -87,25 +87,25 @@
(kill-new (helm-colors-get-rgb candidate)))
(defun helm-color-run-insert-name ()
- "Insert name of color from `helm-source-colors\\='."
+ "Insert name of color from `helm-source-colors'."
(interactive)
(with-helm-alive-p (helm-exit-and-execute-action 'helm-color-insert-name)))
(put 'helm-color-run-insert-name 'helm-only t)
(defun helm-color-run-kill-name ()
- "Kill name of color from `helm-source-colors\\='."
+ "Kill name of color from `helm-source-colors'."
(interactive)
(with-helm-alive-p (helm-exit-and-execute-action 'helm-color-kill-name)))
(put 'helm-color-run-kill-name 'helm-only t)
(defun helm-color-run-insert-rgb ()
- "Insert RGB of color from `helm-source-colors\\='."
+ "Insert RGB of color from `helm-source-colors'."
(interactive)
(with-helm-alive-p (helm-exit-and-execute-action 'helm-color-insert-rgb)))
(put 'helm-color-run-insert-rgb 'helm-only t)
(defun helm-color-run-kill-rgb ()
- "Kill RGB of color from `helm-source-colors\\='."
+ "Kill RGB of color from `helm-source-colors'."
(interactive)
(with-helm-alive-p (helm-exit-and-execute-action 'helm-color-kill-rgb)))
(put 'helm-color-run-kill-rgb 'helm-only t)
@@ -157,7 +157,7 @@
;;;###autoload
(defun helm-colors ()
- "Preconfigured `helm\\=' for color."
+ "Preconfigured `helm' for color."
(interactive)
(helm :sources '(helm-source-colors helm-source-customize-face)
:buffer "*helm colors*"))
diff --git a/helm-comint.el b/helm-comint.el
index 8aba0c3dff..6f85249bfa 100644
--- a/helm-comint.el
+++ b/helm-comint.el
@@ -51,7 +51,7 @@
(defcustom helm-comint-mode-list '(comint-mode slime-repl-mode sly-mrepl-mode
sql-interactive-mode)
"Supported modes for prompt navigation.
-Derived modes (e.g., Geiser\\='s REPL) are automatically supported."
+Derived modes (e.g., Geiser's REPL) are automatically supported."
:group 'helm-comint
:type '(repeat (choice symbol)))
@@ -68,7 +68,7 @@ Derived modes (e.g., Geiser\\='s REPL) are automatically
supported."
(defcustom helm-comint-max-offset 400
"Max number of chars displayed per candidate in comint-input-ring browser.
-When t, don\\='t truncate candidate, show all.
+When t, don't truncate candidate, show all.
By default it is approximatively the number of bits contained in
five lines of 80 chars each i.e 80*5.
Note that if you set this to nil multiline will be disabled, i.e
@@ -83,7 +83,7 @@ you will not have anymore separators between candidates."
(define-key map (kbd "C-c o") 'helm-comint-prompts-other-window)
(define-key map (kbd "C-c C-o") 'helm-comint-prompts-other-frame)
map)
- "Keymap for `helm-comint-prompt-all\\='.")
+ "Keymap for `helm-comint-prompt-all'.")
(defun helm-comint-prompts-list (mode &optional buffer)
"List the prompts in BUFFER in mode MODE.
@@ -110,7 +110,7 @@ If BUFFER is nil, use current buffer."
(defun helm-comint-prompts-list-all (mode)
"List the prompts of all buffers in mode MODE.
-See `helm-comint-prompts-list\\='."
+See `helm-comint-prompts-list'."
(cl-loop for b in (buffer-list)
append (helm-comint-prompts-list mode b)))
@@ -163,7 +163,7 @@ See `helm-comint-prompts-list\\='."
;;;###autoload
(defun helm-comint-prompts ()
- "Pre-configured `helm\\=' to browse the prompts of the current comint
buffer."
+ "Pre-configured `helm' to browse the prompts of the current comint buffer."
(interactive)
(if (apply 'derived-mode-p helm-comint-mode-list)
(helm :sources
@@ -176,7 +176,7 @@ See `helm-comint-prompts-list\\='."
;;;###autoload
(defun helm-comint-prompts-all ()
- "Pre-configured `helm\\=' to browse the prompts of all comint sessions."
+ "Pre-configured `helm' to browse the prompts of all comint sessions."
(interactive)
(if (apply 'derived-mode-p helm-comint-mode-list)
(helm :sources
@@ -212,11 +212,11 @@ See `helm-comint-prompts-list\\='."
;; Multiline does not work for `shell' because of an Emacs bug.
;; It works in other REPLs like Geiser.
:multiline 'helm-comint-max-offset)
- "Source that provides Helm completion against `comint-input-ring\\='.")
+ "Source that provides Helm completion against `comint-input-ring'.")
;;;###autoload
(defun helm-comint-input-ring ()
- "Preconfigured `helm\\=' that provide completion of `comint\\=' history."
+ "Preconfigured `helm' that provide completion of `comint' history."
(interactive)
(when (or (derived-mode-p 'comint-mode)
(member major-mode helm-comint-mode-list))
diff --git a/helm-command.el b/helm-command.el
index cd66eaf34c..800f1fca22 100644
--- a/helm-command.el
+++ b/helm-command.el
@@ -29,12 +29,12 @@
:group 'helm)
(defcustom helm-M-x-always-save-history nil
- "`helm-M-x\\=' save command in `extended-command-history\\=' even when it
fails."
+ "`helm-M-x' save command in `extended-command-history' even when it fails."
:group 'helm-command
:type 'boolean)
(defcustom helm-M-x-reverse-history nil
- "The history source of `helm-M-x\\=' appear in second position when non-nil."
+ "The history source of `helm-M-x' appear in second position when non-nil."
:group 'helm-command
:type 'boolean)
@@ -76,17 +76,17 @@ This value can be toggled with
(defface helm-command-active-mode
'((t :inherit font-lock-builtin-face))
- "Face used by `helm-M-x\\=' for activated modes."
+ "Face used by `helm-M-x' for activated modes."
:group 'helm-command-faces)
(defface helm-M-x-short-doc
'((t :box (:line-width -1) :foreground "DimGray"))
- "Face used by `helm-M-x\\=' for short docstring."
+ "Face used by `helm-M-x' for short docstring."
:group 'helm-command-faces)
(defvar helm-M-x-input-history nil)
(defvar helm-M-x-prefix-argument nil
- "Prefix argument before calling `helm-M-x\\='.")
+ "Prefix argument before calling `helm-M-x'.")
(defvar helm-M-x--timer nil)
(defvar helm-M-x--unwind-forms-done nil)
@@ -100,8 +100,8 @@ This value can be toggled with
(defun helm-get-mode-map-from-mode (mode)
"Guess the mode-map name according to MODE.
-Some modes don\\='t use conventional mode-map name so we need to
-guess mode-map name. E.g. `python-mode\\=' ==> py-mode-map.
+Some modes don't use conventional mode-map name so we need to
+guess mode-map name. E.g. `python-mode' ==> py-mode-map.
Return nil if no mode-map found."
(cl-loop ;; Start with a conventional mode-map name.
with mode-map = (intern-soft (format "%s-map" mode))
@@ -116,7 +116,7 @@ Return nil if no mode-map found."
finally return mode-map))
(defun helm-M-x-current-mode-map-alist ()
- "Return mode-map alist of current `major-mode\\='."
+ "Return mode-map alist of current `major-mode'."
(let ((map-sym (helm-get-mode-map-from-mode major-mode)))
(when (and map-sym (boundp map-sym))
(helm-M-x-get-major-mode-command-alist (symbol-value map-sym)))))
@@ -131,8 +131,8 @@ Return nil if no mode-map found."
(defun helm-M-x-transformer-1 (candidates &optional sort ignore-props)
"Transformer function to show bindings in emacs commands.
Show global bindings and local bindings according to current
-`major-mode\\='.
-If SORT is non nil sort list with `helm-generic-sort-fn\\='.
+`major-mode'.
+If SORT is non nil sort list with `helm-generic-sort-fn'.
Note that SORT should not be used when fuzzy matching because
fuzzy matching is running its own sort function with a different
algorithm."
@@ -181,16 +181,16 @@ algorithm."
(if sort (sort ls #'helm-generic-sort-fn) ls))))
(defun helm-M-x-transformer (candidates _source)
- "Transformer function for `helm-M-x\\=' candidates."
+ "Transformer function for `helm-M-x' candidates."
;; Generic sort function is handling helm-flex.
(helm-M-x-transformer-1 candidates (null helm--in-fuzzy)))
(defun helm-M-x-transformer-no-sort (candidates _source)
- "Transformer function for `helm-M-x\\=' candidates."
+ "Transformer function for `helm-M-x' candidates."
(helm-M-x-transformer-1 candidates))
(defun helm-M-x-transformer-no-sort-no-props (candidates _source)
- "Transformer function for `helm-M-x\\=' candidates."
+ "Transformer function for `helm-M-x' candidates."
(helm-M-x-transformer-1 candidates nil t))
(defun helm-M-x--notify-prefix-arg ()
@@ -217,7 +217,7 @@ algorithm."
results))
(defun helm-M-x-universal-argument ()
- "Same as `universal-argument\\=' but for `helm-M-x\\='."
+ "Same as `universal-argument' but for `helm-M-x'."
(interactive)
(if helm-M-x-prefix-argument
(progn (setq helm-M-x-prefix-argument nil)
@@ -266,17 +266,17 @@ algorithm."
(defun helm-M-x-read-extended-command (collection &optional predicate history)
"Read or execute action on command name in COLLECTION or HISTORY.
-When `helm-M-x-use-completion-styles\\=' is used, Emacs
-`completion-styles\\=' mechanism is used, otherwise standard helm
+When `helm-M-x-use-completion-styles' is used, Emacs
+`completion-styles' mechanism is used, otherwise standard helm
completion and helm fuzzy matching are used together.
Helm completion is not provided when executing or defining kbd
macros.
-Arg COLLECTION should be an `obarray\\=' but can be any object
-suitable for `try-completion\\='. Arg PREDICATE is a function that
-default to `commandp\\=' see also `try-completion\\='. Arg HISTORY
-default to `extended-command-history\\='."
+Arg COLLECTION should be an `obarray' but can be any object
+suitable for `try-completion'. Arg PREDICATE is a function that
+default to `commandp' see also `try-completion'. Arg HISTORY
+default to `extended-command-history'."
(setq helm--mode-line-display-prefarg t)
(let* ((pred (or predicate #'commandp))
(helm-fuzzy-sort-fn (lambda (candidates _source)
@@ -355,8 +355,8 @@ default to `extended-command-history\\='."
(defun helm-M-x-execute-command (command)
"Execute COMMAND as an editor command.
-COMMAND must be a symbol that satisfies the `commandp\\=' predicate.
-Save COMMAND to `extended-command-history\\='."
+COMMAND must be a symbol that satisfies the `commandp' predicate.
+Save COMMAND to `extended-command-history'."
(helm-M-x--unwind-forms t)
(when command
;; Avoid having `this-command' set to *exit-minibuffer.
@@ -389,14 +389,14 @@ Save COMMAND to `extended-command-history\\='."
;;;###autoload
(defun helm-M-x (_arg)
- "Preconfigured `helm\\=' for Emacs commands.
-It is `helm\\=' replacement of regular `M-x\\='
-`execute-extended-command\\='.
+ "Preconfigured `helm' for Emacs commands.
+It is `helm' replacement of regular `M-x'
+`execute-extended-command'.
-Unlike regular `M-x\\=' Emacs vanilla `execute-extended-command\\='
+Unlike regular `M-x' Emacs vanilla `execute-extended-command'
command, the prefix args if needed, can be passed AFTER starting
-`helm-M-x\\='. When a prefix arg is passed BEFORE starting
-`helm-M-x\\=', the first `C-u\\=' while in `helm-M-x\\=' session will
+`helm-M-x'. When a prefix arg is passed BEFORE starting
+`helm-M-x', the first `C-u' while in `helm-M-x' session will
disable it.
You can get help on each command by persistent action."
diff --git a/helm-core.el b/helm-core.el
index 2faf38cebe..7190dc0687 100644
--- a/helm-core.el
+++ b/helm-core.el
@@ -74,7 +74,7 @@ E.g.
(interactive)
(message \"Run baz\"))
-\(helm-define-multi-key global-map (kbd \"<f5> q\") \\='(foo bar baz) 2)
+\(helm-define-multi-key global-map (kbd \"<f5> q\") '(foo bar baz) 2)
Each time \"<f5> q\" is pressed, the next function is executed.
Waiting more than 2 seconds between key presses switches back to
@@ -85,7 +85,7 @@ executing the first function on the next hit."
(defmacro helm-multi-key-defun (name docstring funs &optional delay)
"Define NAME as a multi-key command running FUNS.
After DELAY seconds, the FUNS list is reinitialized.
-See `helm-define-multi-key\\='."
+See `helm-define-multi-key'."
(declare (indent 2))
(setq docstring (if docstring (concat docstring "\n\n")
"This is a helm-ish multi-key command."))
@@ -145,12 +145,12 @@ Arg OTHER-SUBKEYS is an alist specifying other short key
bindings
to use once started, e.g.:
(helm-define-key-with-subkeys global-map
- (kbd \"C-x v n\") ?n \\='git-gutter:next-hunk
- \\='((?p . git-gutter:previous-hunk)))
+ (kbd \"C-x v n\") ?n 'git-gutter:next-hunk
+ '((?p . git-gutter:previous-hunk))\)
-In this example, `C-x v n\\=' will run `git-gutter:next-hunk\\='
+In this example, `C-x v n' will run `git-gutter:next-hunk'
subsequent \"n\" will run this command again and subsequent \"p\"
-will run `git-gutter:previous-hunk\\='.
+will run `git-gutter:previous-hunk'.
If specified PROMPT can be displayed in minibuffer to describe
SUBKEY and OTHER-SUBKEYS. Arg EXIT-FN specifies a function to run
@@ -162,7 +162,7 @@ in MAP and then exit the loop running EXIT-FN, if specified.
If DELAY an integer is specified exit after DELAY seconds.
NOTE: SUBKEY and OTHER-SUBKEYS bindings support only char syntax
-and vectors, so don\\='t use strings to define them."
+and vectors, so don't use strings to define them."
(declare (indent 1))
(define-key map key
(lambda ()
@@ -337,7 +337,7 @@ Default to Helm group when group is not defined in source."
This is a format spec where %d will be replaced by the candidate
number.
-NOTE: `setq\\=' have no effect until you restart Emacs, use
+NOTE: `setq' have no effect until you restart Emacs, use
customize for immediate effect."
:group 'helm
:type 'string
@@ -349,7 +349,7 @@ customize for immediate effect."
This is a format spec where %d will be replaced by the candidate
number.
-NOTE: `setq\\=' have no effect until you restart Emacs, use
+NOTE: `setq' have no effect until you restart Emacs, use
customize for immediate effect."
:group 'helm
:type 'string
@@ -361,23 +361,23 @@ customize for immediate effect."
:prefix "helm-" :group 'convenience)
(defcustom helm-completion-window-scroll-margin 5
- "`scroll-margin\\=' to use for Helm completion window.
+ "`scroll-margin' to use for Helm completion window.
Set to 0 to disable.
-NOTE: This has no effect when `helm-display-source-at-screen-top\\='
+NOTE: This has no effect when `helm-display-source-at-screen-top'
id is non-nil."
:group 'helm
:type 'integer)
(defcustom helm-left-margin-width 0
- "`left-margin-width\\=' value for the `helm-buffer\\='."
+ "`left-margin-width' value for the `helm-buffer'."
:group 'helm
:type 'integer)
(defcustom helm-display-source-at-screen-top t
"Display candidates at the top of screen.
-This happens with `helm-next-source\\=' and `helm-previous-source\\='.
+This happens with `helm-next-source' and `helm-previous-source'.
NOTE: When non-nil (default), disable
-`helm-completion-window-scroll-margin\\='."
+`helm-completion-window-scroll-margin'."
:group 'helm
:type 'boolean)
@@ -400,8 +400,8 @@ Set this value to nil for no limit."
(defcustom helm-exit-idle-delay 0
"Idle time before exiting minibuffer while Helm is updating.
-Has no affect when helm-buffer is up to date (i.e. exit without
-delay in this condition)."
+Has no affect when helm-buffer is up to date \(i.e. exit without
+delay in this condition\)."
:group 'helm
:type 'float)
@@ -417,7 +417,7 @@ If t, then Helm does not pop-up a new window."
(if (fontp (char-displayable-p (read "#x2015")))
"――――――――――――――――――――――――――――――――――――――"
"--------------------------------------")
- "Candidates separator of `multiline\\=' source."
+ "Candidates separator of `multiline' source."
:group 'helm
:type 'string)
@@ -428,7 +428,7 @@ Specified as a pair of functions, where car is the restore
function and cdr is the save function.
To save and restore frame configuration, set this variable to
-\\='(set-frame-configuration . current-frame-configuration)
+'\(set-frame-configuration . current-frame-configuration\)
NOTE: This may not work properly with own-frame minibuffer
settings. Older versions saves/restores frame configuration, but
@@ -437,30 +437,30 @@ the default has changed now to avoid flickering."
:type 'sexp)
(defcustom helm-display-function 'helm-default-display-buffer
- "Function used to display `helm-buffer\\='.
+ "Function used to display `helm-buffer'.
-Local value in `helm-buffer\\=' will take precedence on this default
-value. Commands that are in `helm-commands-using-frame\\=' will have
-`helm-buffer\\=' displayed in frame, `helm-display-function\\=' being
+Local value in `helm-buffer' will take precedence on this default
+value. Commands that are in `helm-commands-using-frame' will have
+`helm-buffer' displayed in frame, `helm-display-function' being
ignored.
If no local value is found and current command is not one of
-`helm-commands-using-frame\\=' use this default value.
+`helm-commands-using-frame' use this default value.
The function in charge of deciding which value use is
-`helm-resolve-display-function\\='.
+`helm-resolve-display-function'.
-To set it locally to `helm-buffer\\=' in Helm sources use
-`helm-set-local-variable\\=' in init function or use
-:display-function slot in `helm\\=' call."
+To set it locally to `helm-buffer' in Helm sources use
+`helm-set-local-variable' in init function or use
+:display-function slot in `helm' call."
:group 'helm
:type 'symbol)
(defcustom helm-case-fold-search 'smart
- "Adds \\='smart\\=' option to `case-fold-search\\='.
+ "Adds 'smart' option to `case-fold-search'.
Smart option ignores case for searches as long as there are no
upper case characters in the pattern.
Use nil or t to turn off smart behavior and use
-`case-fold-search\\=' behavior.
+`case-fold-search' behavior.
Default is smart.
@@ -477,17 +477,17 @@ into their execution process. See helm-grep.el for an
example."
'(cygwin windows-nt ms-dos darwin))
t
helm-case-fold-search)
- "Local setting of `helm-case-fold-search\\=' for reading filenames.
+ "Local setting of `helm-case-fold-search' for reading filenames.
-See `helm-case-fold-search\\=' for more info."
+See `helm-case-fold-search' for more info."
:group 'helm
:type 'symbol)
(defcustom helm-reuse-last-window-split-state nil
"Use the same state of window split, vertical or horizontal.
-`helm-toggle-resplit-window\\=' for the next helm session will use
+`helm-toggle-resplit-window' for the next helm session will use
the same window scheme as the previous session unless
-`helm-split-window-default-side\\=' is \\='same or \\='other."
+`helm-split-window-default-side' is 'same or 'other."
:group 'helm
:type 'boolean)
@@ -497,64 +497,64 @@ the same window scheme as the previous session unless
:type 'function)
(defcustom helm-split-window-default-side 'below
- "The default side to display `helm-buffer\\='.
-Must be one acceptable arg for `split-window\\=' SIDE,
-that is `below\\=', `above\\=', `left\\=' or `right\\='.
+ "The default side to display `helm-buffer'.
+Must be one acceptable arg for `split-window' SIDE,
+that is `below', `above', `left' or `right'.
-Other acceptable values are `same\\=' which always displays
-`helm-buffer\\=' in current window and `other\\=' that displays
-`helm-buffer\\=' below if only one window or in
-`other-window-for-scrolling\\=' when available.
+Other acceptable values are `same' which always displays
+`helm-buffer' in current window and `other' that displays
+`helm-buffer' below if only one window or in
+`other-window-for-scrolling' when available.
-A nil value has same effect as `below\\='. If `helm-full-frame\\=' is
+A nil value has same effect as `below'. If `helm-full-frame' is
non-nil, it take precedence over this setting.
-See also `helm-split-window-inside-p\\=' and
-`helm-always-two-windows\\=' that take precedence over this.
+See also `helm-split-window-inside-p' and
+`helm-always-two-windows' that take precedence over this.
NOTE: this has no effect if
-`helm-split-window-preferred-function\\=' is not
-`helm-split-window-default-fn\\=' unless this new function can
+`helm-split-window-preferred-function' is not
+`helm-split-window-default-fn' unless this new function can
handle this."
:group 'helm
:type 'symbol)
(defcustom helm-split-window-other-side-when-one-window 'below
- "The default side to display `helm-buffer\\=' when (1)
-`helm-split-window-default-side\\=' is \\='other and (2)
+ "The default side to display `helm-buffer' when (1)
+`helm-split-window-default-side' is 'other and (2)
the current frame only has one window. Possible values
-are acceptable args for `split-window\\=' SIDE, that is `below\\=',
-`above\\=', `left\\=' or `right\\='.
+are acceptable args for `split-window' SIDE, that is `below',
+`above', `left' or `right'.
-If `helm-full-frame\\=' is non-nil, it takes precedence over this
+If `helm-full-frame' is non-nil, it takes precedence over this
setting.
-See also `helm-split-window-inside-p\\=' and `helm-always-two-windows\\=' that
+See also `helm-split-window-inside-p' and `helm-always-two-windows' that
takes precedence over this.
NOTE: this has no effect if
-`helm-split-window-preferred-function\\=' is not
-`helm-split-window-default-fn\\=' unless this new function can
+`helm-split-window-preferred-function' is not
+`helm-split-window-default-fn' unless this new function can
handle this."
:group 'helm
:type 'symbol)
(defcustom helm-display-buffer-default-height nil
- "Initial height of `helm-buffer\\=', specified as an integer or a function.
+ "Initial height of `helm-buffer', specified as an integer or a function.
The function should take one arg and be responsible for re-sizing
-the window; function\\='s return value is ignored. Note that this
-has no effect when the split is vertical. See `display-buffer\\='
+the window; function's return value is ignored. Note that this
+has no effect when the split is vertical. See `display-buffer'
for more info."
:group 'helm
:type '(choice integer function))
(defcustom helm-display-buffer-default-width nil
- "Initial width of `helm-buffer\\=', specified as an integer or a function.
+ "Initial width of `helm-buffer', specified as an integer or a function.
The function should take one arg and be responsible for re-sizing
-the window; function\\='s return value is ignored. Note that this
-have no effect when the split is horizontal. See `display-buffer\\='
+the window; function's return value is ignored. Note that this
+have no effect when the split is horizontal. See `display-buffer'
for more info."
:group 'helm
:type '(choice integer function))
@@ -563,11 +563,11 @@ for more info."
(make-obsolete-variable 'helm-split-window-in-side-p
'helm-split-window-inside-p "2.8.6")
(defcustom helm-split-window-inside-p nil
"Force split inside selected window when non-nil.
-See also `helm-split-window-default-side\\='.
+See also `helm-split-window-default-side'.
NOTE: this has no effect if
-`helm-split-window-preferred-function\\=' is not
-`helm-split-window-default-fn\\=' unless this new function can
+`helm-split-window-preferred-function' is not
+`helm-split-window-default-fn' unless this new function can
handle this."
:group 'helm
:type 'boolean)
@@ -575,18 +575,18 @@ handle this."
(defcustom helm-always-two-windows nil
"When non-nil Helm uses two windows in this frame.
-I.e. `helm-buffer\\=' in one window and `helm-current-buffer\\='
+I.e. `helm-buffer' in one window and `helm-current-buffer'
in the other.
-Note: this has no effect when `helm-split-window-inside-p\\=' is
-non-nil, or when `helm-split-window-default-side\\=' is set to
-\\='same.
+Note: this has no effect when `helm-split-window-inside-p' is
+non-nil, or when `helm-split-window-default-side' is set to
+'same.
-When `helm-autoresize-mode\\=' is enabled, setting this to nil
+When `helm-autoresize-mode' is enabled, setting this to nil
will have no effect.
Also when non-nil it overrides the effect of
-`helm-split-window-default-side\\=' set to `other\\='."
+`helm-split-window-default-side' set to `other'."
:group 'helm
:type 'boolean)
@@ -601,22 +601,22 @@ Also when non-nil it overrides the effect of
:type 'integer)
(defcustom helm-default-display-buffer-functions nil
- "Action functions to pass to `display-buffer\\='.
+ "Action functions to pass to `display-buffer'.
See (info \"(elisp) Buffer Display Action Functions\").
-It has no effect when `helm-always-two-windows\\=' is non-nil and
-may override other settings like `helm-split-window-inside-p\\='."
+It has no effect when `helm-always-two-windows' is non-nil and
+may override other settings like `helm-split-window-inside-p'."
:group 'helm
:type '(repeat symbol))
(defcustom helm-default-display-buffer-alist nil
- "Additional alist to pass to `display-buffer\\=' action.
+ "Additional alist to pass to `display-buffer' action.
See (info \"(elisp) Action Alists for Buffer Display\").
-It has no effect when `helm-always-two-windows\\=' is non-nil and
-may override other settings like `helm-split-window-inside-p\\='.
+It has no effect when `helm-always-two-windows' is non-nil and
+may override other settings like `helm-split-window-inside-p'.
Note that window-height and window-width have to be configured in
-`helm-display-buffer-height\\=' and `helm-display-buffer-width\\='."
+`helm-display-buffer-height' and `helm-display-buffer-width'."
:group 'helm
:type '(alist :key-type symbol :value-type sexp))
@@ -630,25 +630,25 @@ Note that window-height and window-width have to be
configured in
helm-source-grep-ag
helm-source-grep-git
helm-source-grep)
- "List of Helm sources that need to use `helm-maybe-use-default-as-input\\='.
-When a source is a member of this list, default `thing-at-point\\='
+ "List of Helm sources that need to use `helm-maybe-use-default-as-input'.
+When a source is a member of this list, default `thing-at-point'
will be used as input."
:group 'helm
:type '(repeat (choice symbol)))
(defcustom helm-delete-minibuffer-contents-from-point t
- "When non-nil, `helm-delete-minibuffer-contents\\=' deletes region from
`point\\='.
-Otherwise it deletes `minibuffer-contents\\='.
-See documentation for `helm-delete-minibuffer-contents\\='."
+ "When non-nil, `helm-delete-minibuffer-contents' deletes region from `point'.
+Otherwise it deletes `minibuffer-contents'.
+See documentation for `helm-delete-minibuffer-contents'."
:group 'helm
:type 'boolean)
(defcustom helm-follow-mode-persistent nil
- "When non-nil, save last state of `helm-follow-mode\\=' for the next Emacs
sessions.
+ "When non-nil, save last state of `helm-follow-mode' for the next Emacs
sessions.
-Each time you turn on or off `helm-follow-mode\\=', the current
+Each time you turn on or off `helm-follow-mode', the current
source name will be stored or removed from
-`helm-source-names-using-follow\\='.
+`helm-source-names-using-follow'.
Note that this may be disabled in some places where it is unsafe
to use because persistent action is changing according to
@@ -659,18 +659,18 @@ context."
(defcustom helm-source-names-using-follow nil
"A list of source names to have follow enabled.
This list of source names will be used only
-when `helm-follow-mode-persistent\\=' is non-nil.
+when `helm-follow-mode-persistent' is non-nil.
-You don\\='t have to customize this yourself unless you really want
+You don't have to customize this yourself unless you really want
and know what you are doing, instead just set
-`helm-follow-mode-persistent\\=' to non-nil and as soon as you turn
-on or off `helm-follow-mode\\=' (C-c C-f) in a source, Helm will
+`helm-follow-mode-persistent' to non-nil and as soon as you turn
+on or off `helm-follow-mode' (C-c C-f) in a source, Helm will
save or remove source name in this variable."
:group 'helm
:type '(repeat (choice string)))
(defcustom helm-prevent-escaping-from-minibuffer t
- "Prevent escaping from minibuffer with `other-window\\=' during the Helm
session."
+ "Prevent escaping from minibuffer with `other-window' during the Helm
session."
:group 'helm
:type 'boolean)
@@ -678,24 +678,24 @@ save or remove source name in this variable."
"Allow mouse usage during the Helm session when non-nil.
Note that this also allows moving out of minibuffer when clicking
-outside of `helm-buffer\\=', so it is up to you to get back to Helm
-by clicking back in `helm-buffer\\=' or minibuffer."
+outside of `helm-buffer', so it is up to you to get back to Helm
+by clicking back in `helm-buffer' or minibuffer."
:group 'helm
:type 'boolean)
(defcustom helm-move-to-line-cycle-in-source nil
"Cycle to the beginning or end of the list after reaching the bottom or top.
-This applies when using `helm-next/previous-line\\='."
+This applies when using `helm-next/previous-line'."
:group 'helm
:type 'boolean)
(defcustom helm-fuzzy-match-fn 'helm-fuzzy-match
- "The function for fuzzy matching in `helm-source-sync\\=' based sources."
+ "The function for fuzzy matching in `helm-source-sync' based sources."
:group 'helm
:type 'function)
(defcustom helm-fuzzy-search-fn 'helm-fuzzy-search
- "The function for fuzzy matching in `helm-source-in-buffer\\=' based
sources."
+ "The function for fuzzy matching in `helm-source-in-buffer' based sources."
:group 'helm
:type 'function)
@@ -710,28 +710,28 @@ This applies when using `helm-next/previous-line\\='."
:type 'function)
(defcustom helm-autoresize-max-height 40
- "Specify maximum height and defaults to percent of Helm window\\='s frame
height.
+ "Specify maximum height and defaults to percent of Helm window's frame
height.
-See `fit-window-to-buffer\\=' for more infos."
+See `fit-window-to-buffer' for more infos."
:group 'helm
:type 'integer)
(defcustom helm-autoresize-min-height 10
- "Specify minimum height and defaults to percent of Helm window\\='s frame
height.
+ "Specify minimum height and defaults to percent of Helm window's frame
height.
-If nil, `window-min-height\\=' is used.
-See `fit-window-to-buffer\\=' for details."
+If nil, `window-min-height' is used.
+See `fit-window-to-buffer' for details."
:group 'helm
:type 'integer)
(defcustom helm-input-method-verbose-flag nil
- "The default value for `input-method-verbose-flag\\=' used in Helm
minibuffer.
+ "The default value for `input-method-verbose-flag' used in Helm minibuffer.
It is nil by default, which does not turn off input method. Helm
updates and exits without interruption -- necessary for complex
methods.
-If set to any other value as per `input-method-verbose-flag\\=',
-then use `C-\\\\=' to disable the `current-input-method\\=' to exit or
+If set to any other value as per `input-method-verbose-flag',
+then use `C-\\' to disable the `current-input-method' to exit or
update Helm."
:group 'helm
:type '(radio :tag "A flag to control extra guidance for input methods in
helm."
@@ -745,9 +745,9 @@ update Helm."
:type 'boolean)
(defcustom helm-inherit-input-method t
- "Inherit `current-input-method\\=' from `current-buffer\\=' when non-nil.
+ "Inherit `current-input-method' from `current-buffer' when non-nil.
The default is to enable this by default and then toggle
-`toggle-input-method\\='."
+`toggle-input-method'."
:group 'helm
:type 'boolean)
@@ -759,12 +759,12 @@ The default is to enable this by default and then toggle
(defcustom helm-header-line-space-before-prompt 'left-fringe
"Specify the space before prompt in header-line.
-This will be used when `helm-echo-input-in-header-line\\=' is
+This will be used when `helm-echo-input-in-header-line' is
non-nil.
-Value can be one of the symbols \\='left-fringe or \\='left-margin or
+Value can be one of the symbols 'left-fringe or 'left-margin or
an integer specifying the number of spaces before prompt. Note
-that on input longer that `window-width\\=' the continuation string
+that on input longer that `window-width' the continuation string
will be shown on left side of window without taking care of
this."
:group 'helm
@@ -775,7 +775,7 @@ this."
integer))
(defcustom helm-tramp-connection-min-time-diff 5
- "Value of `tramp-connection-min-time-diff\\=' for Helm remote processes.
+ "Value of `tramp-connection-min-time-diff' for Helm remote processes.
If set to zero Helm remote processes are not delayed.
Setting this to a value less than 5 or disabling it with a zero
@@ -783,34 +783,34 @@ value is risky, however on Emacs versions starting at
24.5 it
seems it is now possible to disable it.
Anyway at any time in Helm you can suspend your processes while
-typing by hitting \\<helm-map> `\\[helm-toggle-suspend-update]\\='.
+typing by hitting \\<helm-map> `\\[helm-toggle-suspend-update]'.
Only async sources than use a sentinel calling
-`helm-process-deferred-sentinel-hook\\=' are affected by this."
+`helm-process-deferred-sentinel-hook' are affected by this."
:type 'integer
:group 'helm)
(defcustom helm-debug-root-directory nil
"When non-nil, save Helm log messages to a file in this directory.
When nil log messages are saved to a buffer instead. Log message
-are saved only when `helm-debug\\=' is non-nil, so setting this
-doesn\\='t enable debugging by itself.
+are saved only when `helm-debug' is non-nil, so setting this
+doesn't enable debugging by itself.
-See `helm-log-save-maybe\\=' for more info."
+See `helm-log-save-maybe' for more info."
:type 'string
:group 'helm)
(defcustom helm-show-action-window-other-window nil
- "Show action buffer beside `helm-buffer\\=' when non-nil.
+ "Show action buffer beside `helm-buffer' when non-nil.
-If nil don\\='t split and replace helm-buffer by the action buffer
+If nil don't split and replace helm-buffer by the action buffer
in same window.
If left display the action buffer at the left of helm-buffer.
If right or any other value, split at right.
Note that this may not fit well with some Helm window
configurations, so it have only effect when
-`helm-always-two-windows\\=' is non-nil."
+`helm-always-two-windows' is non-nil."
:group 'helm
:type '(choice
(const :tag "Split at left" left)
@@ -818,7 +818,7 @@ configurations, so it have only effect when
(other :tag "Split at right" right)))
(defcustom helm-cycle-resume-delay 1.0
- "Delay used before resuming in `helm-run-cycle-resume\\='."
+ "Delay used before resuming in `helm-run-cycle-resume'."
:type 'float
:group 'helm)
@@ -827,14 +827,14 @@ configurations, so it have only effect when
This was used to workaround a bug in Emacs where frames where
popping up slowly, now that the bug have been fixed upstream
-\(emacs-27) probably you don\\='t want to use this any more. On
-emacs-26 set `x-wait-for-event-timeout\\=' to nil to have your
+\(emacs-27) probably you don't want to use this any more. On
+emacs-26 set `x-wait-for-event-timeout' to nil to have your
frames popping up fast."
:group 'helm
:type 'boolean)
(defcustom helm-commands-using-frame nil
- "A list of commands where `helm-buffer\\=' is displayed in a frame."
+ "A list of commands where `helm-buffer' is displayed in a frame."
:group 'helm
:type '(repeat symbol))
@@ -891,15 +891,15 @@ Fallback to 100 when nil."
:type 'function)
(defcustom helm-truncate-lines nil
- "The value of `truncate-lines\\=' when Helm starts.
-You can toggle later `truncate-lines\\=' with
+ "The value of `truncate-lines' when Helm starts.
+You can toggle later `truncate-lines' with
\\<helm-map>\\[helm-toggle-truncate-line]."
:group 'helm
:type 'boolean)
(defcustom helm-visible-mark-prefix "*"
"Prefix used in margin for marked candidates.
-Set this to an empty string if you don\\='t want prefix in margin when
marking."
+Set this to an empty string if you don't want prefix in margin when marking."
:group 'helm
:type 'string)
@@ -1037,7 +1037,7 @@ Allow specifying the height of this line."
(defface helm-mark-prefix
`((t :inherit default))
- "Face for string `helm-visible-mark-prefix\\='."
+ "Face for string `helm-visible-mark-prefix'."
:group 'helm-faces)
;;; Variables.
@@ -1051,15 +1051,15 @@ Allow specifying the height of this line."
(defvar helm-before-initialize-hook nil
"Runs before Helm initialization.
-This hook runs before init functions in `helm-sources\\=', which is
-before creation of `helm-buffer\\='. Set local variables for
-`helm-buffer\\=' that need a value from `current-buffer\\=' with
-`helm-set-local-variable\\='.")
+This hook runs before init functions in `helm-sources', which is
+before creation of `helm-buffer'. Set local variables for
+`helm-buffer' that need a value from `current-buffer' with
+`helm-set-local-variable'.")
(defvar helm-after-initialize-hook nil
"Runs after Helm initialization.
-This hook runs after `helm-buffer\\=' is created but not from
-`helm-buffer\\='. The hook needs to specify in which buffer to
+This hook runs after `helm-buffer' is created but not from
+`helm-buffer'. The hook needs to specify in which buffer to
run.")
(defvaralias 'helm-update-hook 'helm-after-update-hook)
@@ -1076,14 +1076,14 @@ run.")
action.
This hook runs even if Helm exits the minibuffer abnormally (e.g.
-via `helm-keyboard-quit\\=').")
+via `helm-keyboard-quit').")
(defvar helm-select-action-hook nil
"Runs when opening the action buffer.")
(defvar helm-before-action-hook nil
"Runs before executing action.
-Unlike `helm-cleanup-hook\\=', this hook runs before Helm closes the
+Unlike `helm-cleanup-hook', this hook runs before Helm closes the
minibuffer and also before performing an action.")
(defvar helm-after-action-hook nil
@@ -1094,46 +1094,46 @@ minibuffer and also before performing an action.")
This hook runs when Helm exits the minibuffer normally (e.g., via
candidate selection), but does NOT run if Helm exits the
-minibuffer abnormally (e.g. via `helm-keyboard-quit\\=').")
+minibuffer abnormally (e.g. via `helm-keyboard-quit').")
(defvar helm-after-persistent-action-hook nil
"Runs after executing persistent action.")
(defvar helm-move-selection-before-hook nil
- "Runs before moving selection in `helm-buffer\\='.")
+ "Runs before moving selection in `helm-buffer'.")
(defvar helm-move-selection-after-hook nil
- "Runs after moving selection in `helm-buffer\\='.")
+ "Runs after moving selection in `helm-buffer'.")
(defvar helm-after-preselection-hook nil
- "Runs after pre-selection in `helm-buffer\\='.")
+ "Runs after pre-selection in `helm-buffer'.")
(defvar helm-window-configuration-hook nil
"Runs when switching to and from the action buffer.
-Should run also at end of `helm-display-function\\='.")
+Should run also at end of `helm-display-function'.")
(defvar helm-execute-action-at-once-if-one nil
"When non-nil execute the default action and then exit if only one candidate.
-If symbol \\='current-source is given as value exit if only one
+If symbol 'current-source is given as value exit if only one
candidate in current source. This variable accepts a function
with no args that should returns a boolean value or
-\\='current-source.")
+'current-source.")
(defvar helm-quit-if-no-candidate nil
"When non-nil, quit if there are no candidates.
This variable accepts a function.")
(defvar helm-debug-variables nil
- "A list of Helm variables that `helm-debug-output\\=' displays.
-If nil, `helm-debug-output\\=' includes only variables with `helm-\\='
+ "A list of Helm variables that `helm-debug-output' displays.
+If nil, `helm-debug-output' includes only variables with `helm-'
prefixes.")
(defvar helm-debug-buffer "*Debug Helm Log*")
(defvar helm-debug nil
- "If non-nil, write log message to `helm-debug-buffer\\='.
+ "If non-nil, write log message to `helm-debug-buffer'.
Default is nil, which disables writing log messages because the
-size of `helm-debug-buffer\\=' grows quickly.")
+size of `helm-debug-buffer' grows quickly.")
(defvar helm-mode-line-string "\
\\<helm-map>\
@@ -1146,19 +1146,19 @@ f1..f12:NthAct \
"Help string displayed by Helm in the mode-line.
It is either a string or a list of two string arguments where the
first string is the name and the second string is displayed in
-the mode-line. When nil, it defaults to `mode-line-format\\='.")
+the mode-line. When nil, it defaults to `mode-line-format'.")
(defvar helm-minibuffer-set-up-hook nil
"Hook that runs at minibuffer initialization.
A hook useful for modifying minibuffer settings in Helm.
An example that hides the minibuffer when using
-`helm-echo-input-in-header-line\\=':
+`helm-echo-input-in-header-line':
- (add-hook \\='helm-minibuffer-set-up-hook
#\\='helm-hide-minibuffer-maybe)
+ (add-hook 'helm-minibuffer-set-up-hook #'helm-hide-minibuffer-maybe)
-Note that we check `helm-echo-input-in-header-line\\=' value
-from `helm-buffer\\=' which allows detecting possible local
+Note that we check `helm-echo-input-in-header-line' value
+from `helm-buffer' which allows detecting possible local
value of this var.")
(defvar helm-help-message
@@ -1747,14 +1747,14 @@ examples.
** Helm Map
\\{helm-map}"
- "Message string containing detailed help for `helm\\='.
+ "Message string containing detailed help for `helm'.
It also accepts function or variable symbol.")
(defvar helm-autoresize-mode) ;; Undefined in `helm-default-display-buffer'.
(defvar helm-async-outer-limit-hook nil
- "Run in async sources when process output is out of
`candidate-number-limit\\='.
-Should be set locally to `helm-buffer\\=' with `helm-set-local-variable\\='.")
+ "Run in async sources when process output is out of `candidate-number-limit'.
+Should be set locally to `helm-buffer' with `helm-set-local-variable'.")
(defvar helm-quit-hook nil
"A hook that runs when quitting Helm.")
@@ -1775,9 +1775,9 @@ The hook should takes one arg SOURCES.")
;;
(defvar helm-source-filter nil
"A list of source names to be displayed.
-Other sources won\\='t appear in the search results.
+Other sources won't appear in the search results.
If nil, no filtering is done.
-Don\\='t set this directly, use `helm-set-source-filter\\=' during a
+Don't set this directly, use `helm-set-source-filter' during a
Helm session to modify it.")
(defvar helm-saved-action nil
"Saved value of the currently selected action by key.")
@@ -1786,22 +1786,22 @@ Helm session to modify it.")
(defvar helm-in-persistent-action nil
"Flag whether in persistent-action or not.")
(defvar helm-last-buffer nil
- "`helm-buffer\\=' of a previous Helm session.")
+ "`helm-buffer' of a previous Helm session.")
(defvar helm-saved-selection nil
"Value of the currently selected object when the action list is shown.")
(defvar helm-sources nil
"[INTERNAL] Value of current sources in use, a list of alists.
The list of sources (symbols or alists) is normalized to alists
-in `helm-initialize\\='.")
+in `helm-initialize'.")
(defvar helm-buffer-file-name nil
- "Variable `buffer-file-name\\=' when Helm is invoked.")
+ "Variable `buffer-file-name' when Helm is invoked.")
(defvar helm-candidate-cache (make-hash-table :test 'equal)
"Holds the available candidate within a single Helm invocation.")
(defvar helm--candidate-buffer-alist nil)
(defvar helm-input ""
"The input typed in the candidates panel.")
(defvar helm-input-local nil
- "Internal, store locally `helm-pattern\\=' value for later use in
`helm-resume\\='.")
+ "Internal, store locally `helm-pattern' value for later use in
`helm-resume'.")
(defvar helm--source-name nil)
(defvar helm-current-source nil)
(defvar helm-issued-errors nil)
@@ -1818,22 +1818,22 @@ in `helm-initialize\\='.")
"\\<" "\\>" "\\_<" "\\_>" ".*"
"??" "?*" "*?" "?"))
(defvar helm--force-updating-p nil
- "[INTERNAL] Don\\='t use this in your programs.")
+ "[INTERNAL] Don't use this in your programs.")
(defvar helm-exit-status 0
"Flag to inform if Helm did exit or quit.
0 means Helm did exit when executing an action.
1 means Helm did quit with \\[keyboard-quit]
Knowing this exit-status could help restore a window config when
Helm aborts in some special circumstances. See
-`helm-exit-minibuffer\\=' and `helm-keyboard-quit\\='.")
+`helm-exit-minibuffer' and `helm-keyboard-quit'.")
(defvar helm-minibuffer-confirm-state nil)
(defvar helm--quit nil)
(defvar helm-buffers nil
"Helm buffers listed in order of most recently used.")
(defvar helm-current-position nil
- "Cons of (point . window-start) when Helm is invoked.
-`helm-current-buffer\\=' uses this to restore position after
-`helm-keyboard-quit\\='")
+ "Cons of \(point . window-start\) when Helm is invoked.
+`helm-current-buffer' uses this to restore position after
+`helm-keyboard-quit'")
(defvar helm-last-frame-or-window-configuration nil
"Used to store window or frame configuration at Helm start.")
(defvar helm-onewindow-p nil)
@@ -1841,7 +1841,7 @@ Helm aborts in some special circumstances. See
(defvar helm--mode-line-string-real nil) ; The string to display in mode-line.
(defvar helm-persistent-action-display-window nil)
(defvar helm-marked-candidates nil
- "Marked candidates. List of (source . real) pair.")
+ "Marked candidates. List of \(source . real\) pair.")
(defvar helm--mode-line-display-prefarg nil)
(defvar helm--temp-follow-flag nil
"[INTERNAL] A simple flag to notify persistent action we are following.")
@@ -1851,23 +1851,23 @@ Helm aborts in some special circumstances. See
(defvar helm-maybe-use-default-as-input nil
"Flag to notify the use of use-default-as-input.
Use only in let-bindings.
-Use :default arg of `helm\\=' as input to update display.
-Note that if also :input is specified as `helm\\=' arg, it will take
+Use :default arg of `helm' as input to update display.
+Note that if also :input is specified as `helm' arg, it will take
precedence on :default.")
(defvar helm--temp-hooks nil
- "Store temporary hooks added by `with-helm-temp-hook\\='.")
+ "Store temporary hooks added by `with-helm-temp-hook'.")
(defvar helm--prompt nil)
(defvar helm--file-completion-sources
'("Find Files" "Read File Name")
"Sources that use the *find-files mechanism can be added here.
-Sources generated by `helm-mode\\=' don\\='t need to be added here
+Sources generated by `helm-mode' don't need to be added here
because they are automatically added.
You should not modify this yourself unless you know what you are
doing.")
(defvar helm--completing-file-name nil
- "Non nil when `helm-read-file-name\\=' is running.
-Used for `helm-file-completion-source-p\\='.")
+ "Non nil when `helm-read-file-name' is running.
+Used for `helm-file-completion-source-p'.")
;; Same as `ffap-url-regexp' but keep it here to ensure `ffap-url-regexp' is
not nil.
(defvar helm--url-regexp
"\\`\\(news\\(post\\)?:\\|mailto:\\|file:\\|\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\)://\\)")
(defvar helm--ignore-errors nil
@@ -1879,24 +1879,24 @@ restored at end of session.")
(defvar helm--buffer-in-new-frame-p nil)
(defvar helm-initial-frame nil
"[INTERNAL] The selected frame before starting Helm.
-Helm use this internally to know in which frame it started, don\\='t
+Helm use this internally to know in which frame it started, don't
modify this yourself.")
(defvar helm-popup-frame nil
"The frame where Helm is displayed.
This is only used when Helm is using
-`helm-display-buffer-in-own-frame\\=' as `helm-display-function\\=' and
-`helm-display-buffer-reuse-frame\\=' is non nil.")
+`helm-display-buffer-in-own-frame' as `helm-display-function' and
+`helm-display-buffer-reuse-frame' is non nil.")
(defvar helm--nested nil)
(defconst helm--frame-default-attributes
'(width height tool-bar-lines left top
title undecorated vertical-scroll-bars
visibility fullscreen menu-bar-lines undecorated
alpha foreground-color background-color)
- "Frame parameters to save in `helm--last-frame-parameters\\='.")
+ "Frame parameters to save in `helm--last-frame-parameters'.")
(defvar helm--last-frame-parameters nil
"Frame parameters to save for later resuming.
-Local to `helm-buffer\\='.")
+Local to `helm-buffer'.")
(defvar helm--executing-helm-action nil
"Non nil when action is triggering a new helm-session.
This may be let bounded in other places to notify the display
@@ -1906,8 +1906,8 @@ session just like resume would do.")
(defvar helm--suspend-update-interactive-flag nil)
(defvar helm-persistent-action-window-buffer nil
"[INTERNAL] Store the buffer where helm is started.
-It is generally `helm-current-buffer\\=', but when this one is displayed
-in a dedicated buffer, helm can\\='t start in this window and use another
+It is generally `helm-current-buffer', but when this one is displayed
+in a dedicated buffer, helm can't start in this window and use another
window handling a buffer, it is this one we store.")
(defvar helm--tramp-archive-maybe-loaded nil)
(defvar helm--original-dedicated-windows-alist nil
@@ -1915,11 +1915,11 @@ window handling a buffer, it is this one we store.")
;; Utility: logging
(defun helm-log (format-string &rest args)
- "Log message `helm-debug\\=' is non-nil.
-Messages are written to the `helm-debug-buffer\\=' buffer.
+ "Log message `helm-debug' is non-nil.
+Messages are written to the `helm-debug-buffer' buffer.
-Argument FORMAT-STRING is a string to use with `format\\='.
-Use optional arguments ARGS like in `format\\='."
+Argument FORMAT-STRING is a string to use with `format'.
+Use optional arguments ARGS like in `format'."
(when helm-debug
(with-current-buffer (get-buffer-create helm-debug-buffer)
(outline-mode)
@@ -1936,7 +1936,7 @@ Use optional arguments ARGS like in `format\\='."
(apply #'format (cons format-string args)))))))))
(defun helm-log-run-hook (hook)
- "Run HOOK like `run-hooks\\=' but write these actions to Helm log buffer."
+ "Run HOOK like `run-hooks' but write these actions to Helm log buffer."
(helm-log "Executing %s with value = %S" hook (symbol-value hook))
(helm-log "Executing %s with global value = %S" hook (default-value hook))
(run-hooks hook)
@@ -1952,7 +1952,7 @@ Use optional arguments ARGS like in `format\\='."
helm-funcall-with-source
helm-funcall-foreach
helm-compute-attr-in-sources))
(defun helm-log-get-current-function ()
- "Get name of function calling `helm-log\\='."
+ "Get name of function calling `helm-log'."
(cl-loop for btn from 1 to 40
for btf = (cl-second (backtrace-frame btn))
for fn = (if (symbolp btf) (symbol-name btf) "")
@@ -1961,8 +1961,8 @@ Use optional arguments ARGS like in `format\\='."
return fn))
(defun helm-log-error (&rest args)
- "Accumulate error messages into `helm-issued-errors\\='.
-ARGS are args given to `format\\='.
+ "Accumulate error messages into `helm-issued-errors'.
+ARGS are args given to `format'.
E.g. (helm-log-error \"Error %s: %s\" (car err) (cdr err))."
(apply 'helm-log (concat "ERROR: " (car args)) (cdr args))
(let ((msg (apply 'format args)))
@@ -1970,9 +1970,9 @@ E.g. (helm-log-error \"Error %s: %s\" (car err) (cdr
err))."
(cl-pushnew msg helm-issued-errors :test 'equal))))
(defun helm-log-save-maybe ()
- "Save log buffer when `helm-debug-root-directory\\=' is non nil.
-Create `helm-debug-root-directory\\=' directory if necessary.
-Messages are logged to a file named with today\\='s date and time in
+ "Save log buffer when `helm-debug-root-directory' is non nil.
+Create `helm-debug-root-directory' directory if necessary.
+Messages are logged to a file named with today's date and time in
this directory."
(when (and (stringp helm-debug-root-directory)
(not (file-directory-p helm-debug-root-directory)))
@@ -2011,7 +2011,7 @@ End:")
(view-mode 1) (visual-line-mode 1)))
(defun helm-print-error-messages ()
- "Print error messages in `helm-issued-errors\\='."
+ "Print error messages in `helm-issued-errors'."
(and helm-issued-errors
(message "Helm issued errors: %s"
(mapconcat 'identity (reverse helm-issued-errors) "\n"))))
@@ -2042,7 +2042,7 @@ End:")
,@body))
(defun helm-default-directory ()
- "Return the local value of `default-directory\\=' in `helm-buffer\\='."
+ "Return the local value of `default-directory' in `helm-buffer'."
(buffer-local-value 'default-directory (get-buffer helm-buffer)))
(defmacro with-helm-temp-hook (hook &rest body)
@@ -2056,7 +2056,7 @@ End:")
(add-hook ,hook helm--hook)))
(defmacro with-helm-after-update-hook (&rest body)
- "Execute BODY at end of `helm-update\\='."
+ "Execute BODY at end of `helm-update'."
(declare (indent 0) (debug t))
`(with-helm-temp-hook 'helm-after-update-hook ,@body))
@@ -2069,7 +2069,7 @@ End:")
(error "Running helm command outside of context"))))
(defmacro with-helm-in-frame (&rest body)
- "Execute Helm function in BODY displaying `helm-buffer\\=' in separate
frame."
+ "Execute Helm function in BODY displaying `helm-buffer' in separate frame."
(declare (debug t) (indent 0))
`(progn
(helm-set-local-variable
@@ -2083,15 +2083,15 @@ End:")
If SRC is omitted, use current source.
-If COMPUTE is non-`nil\\=' compute value of ATTRIBUTE-NAME with
-`helm-interpret-value\\='. COMPUTE can have also \\='ignorefn as value,
-in this case `helm-interpret-value\\=' will return a function as
+If COMPUTE is non-`nil' compute value of ATTRIBUTE-NAME with
+`helm-interpret-value'. COMPUTE can have also 'ignorefn as value,
+in this case `helm-interpret-value' will return a function as
value unchanged, but will eval a symbol which is bound.
-You can use `setf\\=' to modify value of ATTRIBUTE-NAME unless
+You can use `setf' to modify value of ATTRIBUTE-NAME unless
COMPUTE is specified, if attribute ATTRIBUTE-NAME is not found in
-SOURCE `setf\\=' will create new attribute ATTRIBUTE-NAME with
-specified value. You can also use `helm-set-attr\\=' to modify
+SOURCE `setf' will create new attribute ATTRIBUTE-NAME with
+specified value. You can also use `helm-set-attr' to modify
ATTRIBUTE-NAME."
(declare (gv-setter
(lambda (val)
@@ -2119,11 +2119,11 @@ ATTRIBUTE-NAME."
(src (helm-get-current-source)))
"Set the value of ATTRIBUTE-NAME of source SRC to VALUE.
-If ATTRIBUTE-NAME doesn\\='t exists in source it is created with
+If ATTRIBUTE-NAME doesn't exists in source it is created with
value VALUE. If SRC is omitted, use current source. If operation
succeed, return value, otherwise nil.
-Using this function is same as using `setf\\=' on `helm-get-attr\\='."
+Using this function is same as using `setf' on `helm-get-attr'."
(setf (helm-get-attr attribute-name src) value))
(defalias 'helm-attrset 'helm-set-attr)
@@ -2163,7 +2163,7 @@ function associated to name."
"Add new action NAME linked to function FN to SOURCE.
Action NAME will be available when the current candidate matches
PREDICATE.
-This function adds an entry in the `action-transformer\\=' attribute
+This function adds an entry in the `action-transformer' attribute
of SOURCE (or creates one if not found).
Function PREDICATE must take one candidate as arg.
Function FN should be a valid function that takes one arg i.e.
@@ -2171,19 +2171,19 @@ candidate, argument NAME is a string that will appear
in action
menu and SOURCE should be an existing Helm source already loaded.
If INDEX is specified, action is added in action list at INDEX.
Value of INDEX should be always >=1, default to 4. This allows
-user to add a specific `action-transformer\\=' to an existing source
+user to add a specific `action-transformer' to an existing source
without modifying source code.
E.g.
Add the action \"Byte compile file async\" linked to function
-\\='async-byte-compile-file to source `helm-source-find-files\\=' only
+'async-byte-compile-file to source `helm-source-find-files' only
when predicate helm-ff-candidates-lisp-p returns non-nil:
\(helm-add-action-to-source-if \"Byte compile file async\"
- \\='async-byte-compile-file
+ 'async-byte-compile-file
helm-source-find-files
- \\='helm-ff-candidates-lisp-p)."
+ 'helm-ff-candidates-lisp-p\)."
(let* ((actions (helm-get-attr 'action source 'ignorefn))
(action-transformers (helm-get-attr 'action-transformer source))
(new-action (list (cons name fn)))
@@ -2208,27 +2208,27 @@ when predicate helm-ff-candidates-lisp-p returns
non-nil:
;;; Source filter
;;
(defun helm-set-source-filter (sources)
- "Set the value of `helm-source-filter\\=' to SOURCES and update.
+ "Set the value of `helm-source-filter' to SOURCES and update.
This function sets a filter for Helm sources and it may be called
while Helm is running. It can be used to toggle displaying of
sources dynamically. For example, additional keys can be bound
-into `helm-map\\=' to display only the file-related results if there
-are too many matches from other sources and you\\='re after files
+into `helm-map' to display only the file-related results if there
+are too many matches from other sources and you're after files
only:
Shift+F shows only file results from some sources:
-\(define-key helm-map \"F\" \\='helm-my-show-files-only)
+\(define-key helm-map \"F\" 'helm-my-show-files-only)
\(defun helm-my-show-files-only ()
(interactive)
- (helm-set-source-filter \\='(\"File Name History\"
+ (helm-set-source-filter '(\"File Name History\"
\"Files from Current Directory\")))
Shift+A shows all results:
-\(define-key helm-map \"A\" \\='helm-my-show-all)
+\(define-key helm-map \"A\" 'helm-my-show-all)
\(defun helm-my-show-all ()
(interactive)
@@ -2253,9 +2253,9 @@ existing Helm function names."
(string s))))
(defun helm-set-sources (sources &optional no-init no-update)
- "Set SOURCES during `helm\\=' invocation.
+ "Set SOURCES during `helm' invocation.
If NO-INIT is non-nil, skip executing init functions of SOURCES.
-If NO-UPDATE is non-nil, skip executing `helm-update\\='."
+If NO-UPDATE is non-nil, skip executing `helm-update'."
(with-current-buffer helm-buffer
(setq helm-sources (helm-get-sources sources))
(helm-log "helm-sources = %S" helm-sources))
@@ -2265,22 +2265,22 @@ If NO-UPDATE is non-nil, skip executing
`helm-update\\='."
(defun helm-get-selection (&optional buffer force-display-part source)
"Return the currently selected candidate from BUFFER.
-If BUFFER is nil or unspecified, use `helm-buffer\\=' as default value.
+If BUFFER is nil or unspecified, use `helm-buffer' as default value.
If FORCE-DISPLAY-PART is non-nil, return the display part of candidate.
-If FORCE-DISPLAY-PART value is `withprop\\=' the display part of
+If FORCE-DISPLAY-PART value is `withprop' the display part of
candidate is returned with its properties.
When FORCE-DISPLAY-PART is nil the real part of candidate is returned.
SOURCE default to current-source when unspecified but it is better to
specify SOURCE when it is already available to avoid to call
-`helm-get-current-source\\=' uselessly.
+`helm-get-current-source' uselessly.
Note that FORCE-DISPLAY-PART when specified takes precedence over
-`display-to-real\\=' attribute, that\\='s mean don\\='t use FORCE-DISPLAY-PART
-when you want the `display-to-real\\=' function(s) to be applied."
+`display-to-real' attribute, that's mean don't use FORCE-DISPLAY-PART
+when you want the `display-to-real' function(s) to be applied."
(with-current-buffer (or buffer helm-buffer)
(unless (or (helm-empty-buffer-p (current-buffer))
(helm-pos-header-line-p))
@@ -2332,7 +2332,7 @@ of (action-display . function)."
(defun helm-get-current-source ()
"Return the source for the current selection.
-Return nil when `helm-buffer\\=' is empty."
+Return nil when `helm-buffer' is empty."
(or helm-current-source
(with-helm-buffer
(or (get-text-property (point) 'helm-cur-source)
@@ -2353,7 +2353,7 @@ Return nil when `helm-buffer\\=' is empty."
(defun helm-run-after-exit (function &rest args)
"Execute FUNCTION with ARGS after exiting Helm.
The action is to call FUNCTION with arguments ARGS.
-Unlike `helm-exit-and-execute-action\\=', this can be used
+Unlike `helm-exit-and-execute-action', this can be used
to call non-actions functions with any ARGS or no ARGS at all.
Use this on commands invoked from key bindings, but not on action
@@ -2431,7 +2431,7 @@ i.e. functions called with RET."
(defun helm-interpret-value (value &optional source compute)
"Interpret VALUE as variable, function or literal and return it.
If VALUE is a function, call it with no arguments and return the value
-unless COMPUTE value is \\='ignorefn.
+unless COMPUTE value is 'ignorefn.
If SOURCE compute VALUE for this source.
If VALUE is a variable, return the value.
If VALUE is a symbol, but it is not a function or a variable, cause an error.
@@ -2449,17 +2449,17 @@ Otherwise, return VALUE itself."
value)))
(defun helm-set-local-variable (&rest args)
- "Bind each pair in ARGS locally to `helm-buffer\\='.
+ "Bind each pair in ARGS locally to `helm-buffer'.
Use this to set local vars before calling helm.
When used from an init or update function
-\(i.e. when `helm-force-update\\=' is running) the variables are set
-using `make-local-variable\\=' within the `helm-buffer\\='.
+\(i.e. when `helm-force-update' is running) the variables are set
+using `make-local-variable' within the `helm-buffer'.
Usage: helm-set-local-variable ([VAR VALUE]...)
-Just like `setq\\=' except that the vars are not set sequentially.
-IOW Don\\='t use VALUE of previous VAR to set the VALUE of next VAR.
+Just like `setq' except that the vars are not set sequentially.
+IOW Don't use VALUE of previous VAR to set the VALUE of next VAR.
\(fn VAR VALUE ...)"
(if helm--force-updating-p
@@ -2491,7 +2491,7 @@ IOW Don\\='t use VALUE of previous VAR to set the VALUE
of next VAR.
;; API helper
(cl-defun helm-empty-buffer-p (&optional (buffer helm-buffer))
"Check if BUFFER have candidates.
-Default value for BUFFER is `helm-buffer\\='."
+Default value for BUFFER is `helm-buffer'."
(zerop (buffer-size (and buffer (get-buffer buffer)))))
(defun helm-empty-source-p ()
@@ -2516,15 +2516,15 @@ was deleted and the candidates list not updated."
"From SOURCE apply FUNCTIONS on ARGS.
This function is used to process filter functions. When filter is
-a `filtered-candidate-transformer\\=', we pass to ARGS
+a \`filtered-candidate-transformer', we pass to ARGS
candidates+source whereas when the filter is
-`candidate-transformer\\=' we pass to ARGS candidates only.
+`candidate-transformer' we pass to ARGS candidates only.
This function is also used to process functions called with no
args, e.g. init functions. In this case it is called without
ARGS.
-See `helm-process-filtered-candidate-transformer\\='
-\`helm-compute-attr-in-sources\\=' and
-\`helm-process-candidate-transformer\\='.
+See `helm-process-filtered-candidate-transformer'
+\`helm-compute-attr-in-sources' and
+\`helm-process-candidate-transformer'.
Arg FUNCTIONS is either a symbol or a list of functions, each
function being applied on ARGS and called on the result of the
@@ -2572,7 +2572,7 @@ precedent function. Return the result of last function
call."
sources))
(defun helm-get-candidate-number (&optional in-current-source)
- "Return candidates number in `helm-buffer\\='.
+ "Return candidates number in `helm-buffer'.
If IN-CURRENT-SOURCE is provided return the number of candidates
of current source only."
(with-helm-buffer
@@ -2651,22 +2651,22 @@ One of the following:
- Symbol whose value is a list of sources
- Alist representing a Helm source.
- In this case the source has no name and is referenced in
- `helm-sources\\=' as a whole alist.
+ `helm-sources' as a whole alist.
*** :input
-Initial input of minibuffer (temporary value of `helm-pattern\\=')
+Initial input of minibuffer (temporary value of `helm-pattern')
*** :prompt
-Minibuffer prompt. Default value is `helm--prompt\\='.
+Minibuffer prompt. Default value is `helm--prompt'.
*** :resume
If t, allow resumption of the previous session of this Helm
command, skipping initialization.
-If \\='noresume, this instance of `helm\\=' cannot be resumed.
+If 'noresume, this instance of `helm' cannot be resumed.
*** :preselect
@@ -2674,7 +2674,7 @@ Initially selected candidate (string or regexp).
*** :buffer
-Buffer name for this Helm session. `helm-buffer\\=' will take this value.
+Buffer name for this Helm session. `helm-buffer' will take this value.
*** :keymap
@@ -2686,9 +2686,9 @@ It is overridden by keymaps specified in sources, and is
kept
only for backward compatibility.
Keymaps should be specified in sources using the :keymap slot
-instead. See `helm-source\\='.
+instead. See `helm-source'.
-This keymap is not restored by `helm-resume\\='.
+This keymap is not restored by `helm-resume'.
*** :default
@@ -2699,15 +2699,15 @@ It can be a string or a list of strings, in this case
\\<minibuffer-local-map>\\[next-history-element] cycles through
the list items, starting with the first.
-If nil, `thing-at-point\\=' is used.
+If nil, `thing-at-point' is used.
-If `helm-maybe-use-default-as-input\\=' is non-nil, display is
+If `helm-maybe-use-default-as-input' is non-nil, display is
updated using this value if this value matches, otherwise it is
ignored. If :input is specified, it takes precedence on :default.
*** :history
-Minibuffer input, by default, is pushed to `minibuffer-history\\='.
+Minibuffer input, by default, is pushed to `minibuffer-history'.
When an argument HISTORY is provided, input is pushed to
HISTORY. HISTORY should be a valid symbol.
@@ -2719,14 +2719,14 @@ Allow running this Helm command in a running Helm
session.
** Other keywords
Other keywords are interpreted as local variables of this Helm
-session. The `helm-\\=' prefix can be omitted. For example,
+session. The `helm-' prefix can be omitted. For example,
-\(helm :sources \\='helm-source-buffers-list
+\(helm :sources 'helm-source-buffers-list
:buffer \"*helm buffers*\"
:candidate-number-limit 10)
Starts a Helm session with the variable
-`helm-candidate-number-limit\\=' set to 10.
+`helm-candidate-number-limit' set to 10.
** Backward compatibility
@@ -2773,9 +2773,9 @@ However, the use of non-keyword args is deprecated.
(apply fn plist))))) ; [1] fn == helm-internal.
(defun helm--alive-p ()
- "[INTERNAL] Check if `helm\\=' is alive.
-An Helm session is considered alive if `helm-alive-p\\=' value is
-non-nil, the `helm-buffer\\=' is visible, and cursor is in the
+ "[INTERNAL] Check if `helm' is alive.
+An Helm session is considered alive if `helm-alive-p' value is
+non-nil, the `helm-buffer' is visible, and cursor is in the
minibuffer."
(and helm-alive-p
(get-buffer-window (helm-buffer-get) 'visible)
@@ -2783,15 +2783,15 @@ minibuffer."
(minibufferp (current-buffer))))
(defun helm-parse-keys (keys)
- "Parse the KEYS arguments of `helm\\='.
-Return only those keys not in `helm-argument-keys\\=', prefix them
+ "Parse the KEYS arguments of `helm'.
+Return only those keys not in `helm-argument-keys', prefix them
with \"helm\", and then convert them to an alist. This allows
-adding arguments that are not part of `helm-argument-keys\\=', but
+adding arguments that are not part of `helm-argument-keys', but
are valid helm variables nevertheless. For example,
-:candidate-number-limit is bound to `helm-candidate-number-limit\\='
+:candidate-number-limit is bound to `helm-candidate-number-limit'
in the source.
- (helm-parse-keys \\='(:sources ((name . \"test\")
+ (helm-parse-keys '(:sources ((name . \"test\")
(candidates . (a b c)))
:buffer \"toto\"
:candidate-number-limit 4))
@@ -2823,9 +2823,9 @@ in the source.
prompt resume
preselect buffer
keymap default history)
- "The internal Helm function called by `helm\\='.
+ "The internal Helm function called by `helm'.
For SOURCES INPUT PROMPT RESUME PRESELECT BUFFER KEYMAP DEFAULT and
-HISTORY args see `helm\\='."
+HISTORY args see `helm'."
(cl-assert (or (stringp input)
(null input))
nil "Error in %S buffer: Initial input should be a string or nil"
@@ -2949,7 +2949,7 @@ HISTORY args see `helm\\='."
"Resume a previous Helm session.
Call with a prefix arg to choose among existing Helm
buffers (sessions). When calling from Lisp, specify a
-`buffer-name\\=' as a string with ARG."
+`buffer-name' as a string with ARG."
(interactive "P")
(let (buffer
cur-dir
@@ -3023,8 +3023,8 @@ buffers (sessions). When calling from Lisp, specify a
(eq resume t))
(defun helm-resume-select-buffer ()
- "Select an `helm-buffer\\=' in `helm-buffers\\=' list to resume a helm
session.
-Return nil if no `helm-buffer\\=' found."
+ "Select an `helm-buffer' in `helm-buffers' list to resume a helm session.
+Return nil if no `helm-buffer' found."
(when helm-buffers
(or (helm :sources (helm-build-sync-source "Resume helm buffer"
:candidates helm-buffers)
@@ -3034,7 +3034,7 @@ Return nil if no `helm-buffer\\=' found."
;;;###autoload
(defun helm-cycle-resume ()
- "Cycle in `helm-buffers\\=' list and resume when waiting more than 1.2s."
+ "Cycle in `helm-buffers' list and resume when waiting more than 1.2s."
(interactive)
(cl-assert (and helm-buffers helm-last-buffer)
nil "No helm buffers to resume")
@@ -3062,7 +3062,7 @@ Return nil if no `helm-buffer\\=' found."
(helm-iter-next helm--cycle-resume-iterator))))))
(defun helm-run-cycle-resume ()
- "Same as `helm-cycle-resume\\=' but intended to be called only from Helm."
+ "Same as `helm-cycle-resume' but intended to be called only from Helm."
(interactive)
(when (cdr helm-buffers) ; only one session registered.
;; Setup a new iterator only on first hit on
@@ -3082,19 +3082,19 @@ Return nil if no `helm-buffer\\=' found."
;;;###autoload
(defun helm-other-buffer (sources buffer)
- "Simplified Helm interface with other `helm-buffer\\='.
-Call `helm\\=' only with SOURCES and BUFFER as args."
+ "Simplified Helm interface with other `helm-buffer'.
+Call `helm' only with SOURCES and BUFFER as args."
(helm :sources sources :buffer buffer))
;;; Nested sessions
;;
;;
(defun helm--nest (&rest same-as-helm)
- "[INTERNAL] Allow calling `helm\\=' within a running Helm session.
+ "[INTERNAL] Allow calling `helm' within a running Helm session.
-Arguments SAME-AS-HELM are the same as `helm\\='.
+Arguments SAME-AS-HELM are the same as `helm'.
-Don\\='t use this directly, use instead `helm\\=' with the keyword
+Don't use this directly, use instead `helm' with the keyword
:allow-nest.
\(fn &key SOURCES INPUT PROMPT RESUME PRESELECT BUFFER KEYMAP DEFAULT HISTORY
OTHER-LOCAL-VARS)"
@@ -3158,7 +3158,7 @@ Don\\='t use this directly, use instead `helm\\=' with
the keyword
;;; Accessors
;;
(defun helm-current-position (save-or-restore)
- "Save or restore current position in `helm-current-buffer\\='.
+ "Save or restore current position in `helm-current-buffer'.
Argument SAVE-OR-RESTORE is either save or restore."
(cl-case save-or-restore
(save
@@ -3182,7 +3182,7 @@ Argument SAVE-OR-RESTORE is either save or restore."
(defun helm-frame-or-window-configuration (save-or-restore)
"Save or restore last frame or window configuration.
Argument SAVE-OR-RESTORE is either save or restore of window or
-frame configuration as per `helm-save-configuration-functions\\='."
+frame configuration as per `helm-save-configuration-functions'."
(helm-log "helm-save-configuration-functions = %S"
helm-save-configuration-functions)
(let ((window-persistent-parameters (append '((no-other-window . t))
@@ -3228,16 +3228,16 @@ frame configuration as per
`helm-save-configuration-functions\\='."
(select-frame-set-input-focus frame))))))
(defun helm-split-window-default-fn (window)
- "Default function to split windows before displaying `helm-buffer\\='.
+ "Default function to split windows before displaying `helm-buffer'.
It is used as default value for
-`helm-split-window-preferred-function\\=' which is then the
-let-bounded value of `split-window-preferred-function\\=' in
-`helm-display-buffer\\='. When `helm-display-function\\=' which default
-to `helm-default-display-buffer\\=' is called from
-`helm-display-buffer\\=' the value of
-`split-window-preferred-function\\=' will be used by
-`display-buffer\\='."
+`helm-split-window-preferred-function' which is then the
+let-bounded value of `split-window-preferred-function' in
+`helm-display-buffer'. When `helm-display-function' which default
+to `helm-default-display-buffer' is called from
+`helm-display-buffer' the value of
+`split-window-preferred-function' will be used by
+`display-buffer'."
(let* (split-width-threshold
(win (if (and (fboundp 'window-in-direction)
;; Don't try to split when starting in a minibuffer
@@ -3273,13 +3273,13 @@ to `helm-default-display-buffer\\=' is called from
win))
(defun helm-window-in-direction (direction)
- "Same as `window-in-direction\\=' but check if window is dedicated.
+ "Same as `window-in-direction' but check if window is dedicated.
Return nil when window is dedicated."
(helm-aif (window-in-direction direction)
(and (not (window-dedicated-p it)) it)))
(defun helm-other-window-for-scrolling ()
- "Same as `other-window-for-scrolling\\=' but check if window is dedicated.
+ "Same as `other-window-for-scrolling' but check if window is dedicated.
Returns nil when window is dedicated."
(helm-aif (other-window-for-scrolling)
(and (not (window-dedicated-p it)) it)))
@@ -3289,15 +3289,15 @@ Returns nil when window is dedicated."
;;
;;
(defun helm-resolve-display-function (com)
- "Decide which display function to use according to
`helm-commands-using-frame\\='.
+ "Decide which display function to use according to
`helm-commands-using-frame'.
-The `helm-display-function\\=' buffer local value takes precedence
-on `helm-commands-using-frame\\='.
-If `helm-initial-frame\\=' has no minibuffer, use
-`helm-display-buffer-in-own-frame\\=' function.
-Fallback to global value of `helm-display-function\\=' when no local
+The `helm-display-function' buffer local value takes precedence
+on `helm-commands-using-frame'.
+If `helm-initial-frame' has no minibuffer, use
+`helm-display-buffer-in-own-frame' function.
+Fallback to global value of `helm-display-function' when no local
value found and current command is not in
-`helm-commands-using-frame\\='."
+`helm-commands-using-frame'."
(let ((win (get-buffer-window helm-current-buffer)))
(or (with-helm-buffer helm-display-function)
(and (or (memq com helm-commands-using-frame)
@@ -3315,9 +3315,9 @@ value found and current command is not in
(defun helm-display-buffer (buffer &optional resume)
"Display BUFFER.
-The function used to display `helm-buffer\\=' by calling
-`helm-display-function\\=' which splits window with
-`helm-split-window-preferred-function\\='."
+The function used to display `helm-buffer' by calling
+`helm-display-function' which splits window with
+`helm-split-window-preferred-function'."
(let ((split-window-preferred-function
helm-split-window-preferred-function)
(helm-split-window-default-side
@@ -3343,8 +3343,8 @@ The function used to display `helm-buffer\\=' by calling
(helm-prevent-switching-other-window)))))
(cl-defun helm-prevent-switching-other-window (&key (enabled t))
- "Allow setting `no-other-window\\=' parameter for all windows.
-Arg ENABLE is the value of `no-other-window\\=' window property."
+ "Allow setting `no-other-window' parameter for all windows.
+Arg ENABLE is the value of `no-other-window' window property."
(walk-windows
(lambda (w)
(unless (window-dedicated-p w)
@@ -3352,11 +3352,11 @@ Arg ENABLE is the value of `no-other-window\\=' window
property."
0))
(defun helm-default-display-buffer (buffer &optional _resume)
- "Default function to display `helm-buffer\\=' BUFFER.
+ "Default function to display `helm-buffer' BUFFER.
-It is the default value of `helm-display-function\\='.
-It uses `switch-to-buffer\\=' or `display-buffer\\=' depending on the
-value of `helm-full-frame\\=' or `helm-split-window-default-side\\='."
+It is the default value of `helm-display-function'.
+It uses `switch-to-buffer' or `display-buffer' depending on the
+value of `helm-full-frame' or `helm-split-window-default-side'."
(let (pop-up-frames
(curwin (get-buffer-window helm-current-buffer)))
(if (or (buffer-local-value 'helm-full-frame (get-buffer buffer))
@@ -3391,11 +3391,11 @@ value of `helm-full-frame\\=' or
`helm-split-window-default-side\\='."
(defun helm-display-buffer-in-own-frame (buffer &optional resume)
"Display Helm buffer BUFFER in a separate frame.
-Function suitable for `helm-display-function\\=',
-`helm-completion-in-region-display-function\\=' and/or
-`helm-show-completion-default-display-function\\='.
+Function suitable for `helm-display-function',
+`helm-completion-in-region-display-function' and/or
+`helm-show-completion-default-display-function'.
-See `helm-display-buffer-height\\=' and `helm-display-buffer-width\\='
+See `helm-display-buffer-height' and `helm-display-buffer-width'
to configure frame size.
Note that this feature is available only with emacs-25+."
@@ -3521,7 +3521,7 @@ Return the resulting list."
(defun helm-initialize (resume input default sources)
"Start initialization of Helm session.
-For RESUME INPUT DEFAULT and SOURCES see `helm\\='."
+For RESUME INPUT DEFAULT and SOURCES see `helm'."
(helm-log "start initialization: resume=%S input=%S"
resume input)
(helm-frame-or-window-configuration 'save)
@@ -3624,7 +3624,7 @@ For RESUME INPUT DEFAULT and SOURCES see `helm\\='."
(defun helm--run-init-hooks (hook sources)
"Run after and before init hooks local to source.
-See :after-init-hook and :before-init-hook in `helm-source\\='."
+See :after-init-hook and :before-init-hook in `helm-source'."
(cl-loop with sname = (cl-ecase hook
(before-init-hook "h-before-init-hook")
(after-init-hook "h-after-init-hook"))
@@ -3637,7 +3637,7 @@ See :after-init-hook and :before-init-hook in
`helm-source\\='."
else do (helm-log-run-hook hv)))
(defun helm-restore-position-on-quit ()
- "Restore position in `helm-current-buffer\\=' when quitting."
+ "Restore position in `helm-current-buffer' when quitting."
(helm-current-position 'restore))
(defun helm--push-and-remove-dups (elm sym)
@@ -3645,10 +3645,10 @@ See :after-init-hook and :before-init-hook in
`helm-source\\='."
(set sym (cons elm (delete elm (symbol-value sym)))))
(defun helm--current-buffer ()
- "[INTERNAL] Return `current-buffer\\=' BEFORE `helm-buffer\\=' is
initialized.
+ "[INTERNAL] Return `current-buffer' BEFORE `helm-buffer' is initialized.
Note that it returns the minibuffer in use after Helm has started
-and is intended for `helm-initial-setup\\='. To get the buffer where
-Helm was started, use `helm-current-buffer\\=' instead."
+and is intended for `helm-initial-setup'. To get the buffer where
+Helm was started, use `helm-current-buffer' instead."
(if (minibuffer-window-active-p (minibuffer-window))
;; If minibuffer is active be sure to use it's buffer
;; as `helm-current-buffer', this allow to use helm
@@ -3666,12 +3666,12 @@ Helm was started, use `helm-current-buffer\\=' instead."
(define-derived-mode helm-major-mode
fundamental-mode "Hmm"
"[INTERNAL] Provide major-mode name in Helm buffers.
-Unuseful when used outside Helm, don\\='t use it.")
+Unuseful when used outside Helm, don't use it.")
(put 'helm-major-mode 'mode-class 'special)
(put 'helm-major-mode 'helm-only t)
(defun helm-create-helm-buffer ()
- "Create and setup `helm-buffer\\='."
+ "Create and setup `helm-buffer'."
(let ((root-dir default-directory)
(inhibit-read-only t))
(with-current-buffer (get-buffer-create helm-buffer)
@@ -3709,7 +3709,7 @@ Unuseful when used outside Helm, don\\='t use it.")
(define-minor-mode helm--minor-mode
"[INTERNAL] Enable keymap in Helm minibuffer.
Since this mode has no effect when run outside of Helm context,
-please don\\='t use it outside of Helm.
+please don't use it outside of Helm.
\\{helm-map}"
:group 'helm
@@ -3725,7 +3725,7 @@ please don\\='t use it outside of Helm.
input preselect resume
keymap default history)
"Read pattern with prompt PROMPT and initial input INPUT.
-For PRESELECT RESUME KEYMAP DEFAULT HISTORY, see `helm\\='."
+For PRESELECT RESUME KEYMAP DEFAULT HISTORY, see `helm'."
(with-helm-buffer
(if (and (helm-resume-p resume)
;; When no source, helm-buffer is empty
@@ -3889,8 +3889,8 @@ Update is reenabled when idle 1s."
(defun helm--suspend-read-passwd (old--fn &rest args)
"Suspend Helm while reading password.
-This is used to advice `tramp-read-passwd\\=', `ange-ftp-get-passwd\\='
-and `epa-passphrase-callback-function\\='."
+This is used to advice `tramp-read-passwd', `ange-ftp-get-passwd'
+and `epa-passphrase-callback-function'."
;; Suspend update when prompting for a tramp password.
(setq helm-suspend-update-flag t)
(setq overriding-terminal-local-map nil)
@@ -3905,7 +3905,7 @@ and `epa-passphrase-callback-function\\='."
(defun helm--maybe-update-keymap (&optional map)
"Handle different keymaps in multiples sources.
-Overrides `helm-map\\=' with the local map of current source. If no
+Overrides `helm-map' with the local map of current source. If no
map is found in current source, does nothing (keeps previous
map)."
(with-helm-buffer
@@ -4131,19 +4131,19 @@ Cache the candidates if there is no cached value yet."
;;; Candidate transformers
(defun helm-process-candidate-transformer (candidates source)
- "Execute `candidate-transformer\\=' function(s) on CANDIDATES in SOURCE."
+ "Execute `candidate-transformer' function(s) on CANDIDATES in SOURCE."
(helm-aif (assoc-default 'candidate-transformer source)
(helm-apply-functions-from-source source it candidates)
candidates))
(defun helm-process-filtered-candidate-transformer (candidates source)
- "Execute `filtered-candidate-transformer\\=' function(s) on CANDIDATES in
SOURCE."
+ "Execute `filtered-candidate-transformer' function(s) on CANDIDATES in
SOURCE."
(helm-aif (assoc-default 'filtered-candidate-transformer source)
(helm-apply-functions-from-source source it candidates source)
candidates))
(defmacro helm--maybe-process-filter-one-by-one-candidate (candidate source)
- "Execute `filter-one-by-one\\=' function(s) on real value of CANDIDATE in
SOURCE."
+ "Execute `filter-one-by-one' function(s) on real value of CANDIDATE in
SOURCE."
`(helm-aif (assoc-default 'filter-one-by-one ,source)
(let ((real (if (consp ,candidate)
(cdr ,candidate)
@@ -4157,7 +4157,7 @@ Cache the candidates if there is no cached value yet."
,candidate))
(defun helm--initialize-one-by-one-candidates (candidates source)
- "Process CANDIDATES with the `filter-one-by-one\\=' function in SOURCE.
+ "Process CANDIDATES with the `filter-one-by-one' function in SOURCE.
Return CANDIDATES unchanged when pattern is not empty."
(helm-aif (and (string= helm-pattern "")
(assoc-default 'filter-one-by-one source))
@@ -4167,9 +4167,9 @@ Return CANDIDATES unchanged when pattern is not empty."
(defun helm-process-filtered-candidate-transformer-maybe
(candidates source process-p)
- "Execute `filtered-candidate-transformer\\=' function(s) on CANDIDATES in
SOURCE.
+ "Execute `filtered-candidate-transformer' function(s) on CANDIDATES in
SOURCE.
When PROCESS-P is non-nil execute
-`filtered-candidate-transformer\\=' functions if some, otherwise
+`filtered-candidate-transformer' functions if some, otherwise
return CANDIDATES."
(if process-p
;; When no filter return CANDIDATES unmodified.
@@ -4193,12 +4193,12 @@ return CANDIDATES."
"Transform CANDIDATES from SOURCE according to candidate transformers.
When PROCESS-P is non-nil executes the
-`filtered-candidate-transformer\\=' functions, otherwise processes
-`candidate-transformer\\=' functions only,
-`filtered-candidate-transformer\\=' functions being processed later,
+`filtered-candidate-transformer' functions, otherwise processes
+`candidate-transformer' functions only,
+`filtered-candidate-transformer' functions being processed later,
after the candidates have been narrowed by
-`helm-candidate-number-limit\\=', see `helm-compute-matches\\='. When
-`real-to-display\\=' attribute is present, execute its functions on all
+`helm-candidate-number-limit', see `helm-compute-matches'. When
+`real-to-display' attribute is present, execute its functions on all
maybe filtered CANDIDATES."
(helm-process-real-to-display
(helm-process-filtered-candidate-transformer-maybe
@@ -4211,11 +4211,11 @@ maybe filtered CANDIDATES."
;; Narrowing candidates
(defun helm-candidate-number-limit (source)
"Apply candidate-number-limit attribute value.
-This overrides `helm-candidate-number-limit\\=' variable.
+This overrides `helm-candidate-number-limit' variable.
E.g.:
-If (candidate-number-limit) is in SOURCE, show all candidates in SOURCE.
-If (candidate-number-limit . 123) is in SOURCE limit candidate to 123."
+If \(candidate-number-limit\) is in SOURCE, show all candidates in SOURCE.
+If \(candidate-number-limit . 123\) is in SOURCE limit candidate to 123."
(helm-aif (assq 'candidate-number-limit source)
;; When assoc value is nil use by default 99999999 otherwise use
;; the assoc value, when it is a symbol interpret its value (bug#1831).
@@ -4224,7 +4224,7 @@ If (candidate-number-limit . 123) is in SOURCE limit
candidate to 123."
(defun helm-candidate-get-display (candidate)
"Get searched display part from CANDIDATE.
-CANDIDATE is either a string, a symbol, or a (DISPLAY . REAL)
+CANDIDATE is either a string, a symbol, or a \(DISPLAY . REAL\)
cons cell."
(cond ((car-safe candidate))
((symbolp candidate)
@@ -4240,8 +4240,8 @@ cons cell."
pattern))
(defun helm-default-match-function (candidate)
- "Check if `helm-pattern\\=' match CANDIDATE.
-Default function to match candidates according to `helm-pattern\\='."
+ "Check if `helm-pattern' match CANDIDATE.
+Default function to match candidates according to `helm-pattern'."
(string-match helm-pattern candidate))
@@ -4276,8 +4276,8 @@ Default function to match candidates according to
`helm-pattern\\='."
helm--fuzzy-regexp-cache)))))
(defun helm-fuzzy-match (candidate)
- "Check if `helm-pattern\\=' fuzzy matches CANDIDATE.
-This function is used with sources built with `helm-source-sync\\='."
+ "Check if `helm-pattern' fuzzy matches CANDIDATE.
+This function is used with sources built with `helm-source-sync'."
(unless (string-match " " helm-pattern)
;; When pattern have one or more spaces, let
;; multi-match doing the job with no fuzzy matching.[1]
@@ -4287,8 +4287,8 @@ This function is used with sources built with
`helm-source-sync\\='."
(string-match regexp candidate)))))
(defun helm-fuzzy-search (pattern)
- "Same as `helm-fuzzy-match\\=' but for sources built with
-`helm-source-in-buffer\\='."
+ "Same as `helm-fuzzy-match' but for sources built with
+`helm-source-in-buffer'."
(unless (string-match " " helm-pattern)
;; Same as in `helm-fuzzy-match' ref[1].
(let* ((regexps (gethash 'helm-pattern helm--fuzzy-regexp-cache))
@@ -4340,7 +4340,7 @@ This function is used with sources built with
`helm-source-sync\\='."
"Give a score to CANDIDATE according to PATTERN.
A regexp is generated from PATTERN to calculate score.
Score is calculated with the emacs-27 flex algorithm using
-`helm-flex--style-score\\='."
+`helm-flex--style-score'."
(let ((regexp (helm-aif (gethash pattern helm--fuzzy-flex-regexp-cache)
it
(clrhash helm--fuzzy-flex-regexp-cache)
@@ -4409,7 +4409,7 @@ CANDIDATE. Contiguous matches get a coefficient of 2."
It sorts on the display part by default.
It sorts CANDIDATES by their scores as calculated by
-`helm-score-candidate-for-pattern\\='. Set USE-REAL to non-nil to
+`helm-score-candidate-for-pattern'. Set USE-REAL to non-nil to
sort on the real part. If BASENAME is non-nil assume we are
completing filenames and sort on basename of candidates. If
PRESERVE-TIE-ORDER is nil, ties in scores are sorted by length of
@@ -4454,15 +4454,15 @@ the candidates."
((> scr1 scr2)))))))))
(defun helm-fuzzy-matching-default-sort-fn (candidates _source)
- "Default `filtered-candidate-transformer\\=' to sort in fuzzy matching."
+ "Default `filtered-candidate-transformer' to sort in fuzzy matching."
(helm-fuzzy-matching-default-sort-fn-1 candidates))
(defun helm-fuzzy-matching-sort-fn-preserve-ties-order (candidates _source)
- "Same as `helm-fuzzy-matching-default-sort-fn\\=' but preserving order of
ties.
-The default function, `helm-fuzzy-matching-default-sort-fn\\=',
+ "Same as `helm-fuzzy-matching-default-sort-fn' but preserving order of ties.
+The default function, `helm-fuzzy-matching-default-sort-fn',
sorts ties by length, shortest first. This function may be more
useful when the order of the candidates is meaningful, e.g. with
-`recentf-list\\='."
+`recentf-list'."
(helm-fuzzy-matching-default-sort-fn-1 candidates nil nil t))
(defun helm--maybe-get-migemo-pattern (pattern &optional diacritics)
@@ -4474,7 +4474,7 @@ useful when the order of the candidates is meaningful,
e.g. with
(defun helm-fuzzy-default-highlight-match (candidate &optional diacritics)
"The default function to highlight matches in fuzzy matching.
-Highlight elements in CANDIDATE matching `helm-pattern\\=' according
+Highlight elements in CANDIDATE matching `helm-pattern' according
to the matching method in use."
(if (string= helm-pattern "")
;; Empty pattern, do nothing.
@@ -4541,7 +4541,7 @@ to the matching method in use."
(defun helm-fuzzy-highlight-matches (candidates source)
"The filtered-candidate-transformer function to highlight fuzzy matches.
-See `helm-fuzzy-default-highlight-match\\='."
+See `helm-fuzzy-default-highlight-match'."
(cl-assert helm-fuzzy-matching-highlight-fn nil "Wrong type argument
functionp: nil")
(cl-loop with diac = (helm-get-attr 'diacritics source)
for c in candidates
@@ -4556,13 +4556,13 @@ See `helm-fuzzy-default-highlight-match\\='."
"Score STR candidate according to REGEXP.
REGEXP should be generated from a pattern which is a list like
-\\\='(point \"f\" any \"o\" any \"b\" any) for \"fob\" as pattern.
+\'(point \"f\" any \"o\" any \"b\" any) for \"fob\" as pattern.
Such pattern may be build with
-`helm-completion--flex-transform-pattern\\=' function, and the regexp
-with `completion-pcm--pattern->regex\\='. For commodity,
-`helm--fuzzy-flex-pattern-to-regexp\\=' is used to build such regexp.
+`helm-completion--flex-transform-pattern' function, and the regexp
+with `completion-pcm--pattern->regex'. For commodity,
+`helm--fuzzy-flex-pattern-to-regexp' is used to build such regexp.
-Function extracted from `completion-pcm--hilit-commonality\\=' in
+Function extracted from `completion-pcm--hilit-commonality' in
emacs-27 to provide such scoring in emacs<27."
;; Don't modify the string itself.
(setq str (copy-sequence str))
@@ -4733,8 +4733,8 @@ emacs-27 to provide such scoring in emacs<27."
'helm-multiline t)))))
(defmacro helm-while-no-input (&rest body)
- "Same as `while-no-input\\=' but returns either BODY or nil.
-Unlike `while-no-input\\=' this macro ensure to not returns `t\\='."
+ "Same as `while-no-input' but returns either BODY or nil.
+Unlike `while-no-input' this macro ensure to not returns `t'."
(declare (debug t) (indent 0))
(let ((catch-sym (make-symbol "input")))
`(with-local-quit
@@ -4750,7 +4750,7 @@ Unlike `while-no-input\\=' this macro ensure to not
returns `t\\='."
(t val)))))))
(defmacro helm--maybe-use-while-no-input (&rest body)
- "Wrap BODY in `helm-while-no-input\\=' unless initializing a remote
connection."
+ "Wrap BODY in `helm-while-no-input' unless initializing a remote connection."
`(progn
(if (and (file-remote-p helm-pattern)
(not (file-remote-p helm-pattern nil t)))
@@ -4770,10 +4770,10 @@ Unlike `while-no-input\\=' this macro ensure to not
returns `t\\='."
"Return a list of matches for each source in SRC-LIST.
The resulting value is a list of lists, e.g. ((a b c) (c d) (e
-f)) or (nil nil nil) for three sources when no matches found,
+f)) or \(nil nil nil) for three sources when no matches found,
however this function can be interrupted by new input and in this
case returns a plain nil i.e. not (nil), in this case
-`helm-update\\=' is not rendering the source, keeping previous
+`helm-update' is not rendering the source, keeping previous
candidates in display."
(let ((matches (helm--maybe-use-while-no-input
(cl-loop for src in src-list
@@ -4785,9 +4785,9 @@ candidates in display."
;;
;;
(cl-defun helm-set-case-fold-search (&optional (pattern helm-pattern))
- "Used to set the value of `case-fold-search\\=' in Helm.
-Return t or nil depending on the value of `helm-case-fold-search\\='
-and `helm-pattern\\='."
+ "Used to set the value of `case-fold-search' in Helm.
+Return t or nil depending on the value of `helm-case-fold-search'
+and `helm-pattern'."
(if helm-alive-p
(let ((helm-case-fold-search
(helm-aif (assq 'case-fold-search (helm-get-current-source))
@@ -4813,7 +4813,7 @@ and `helm-pattern\\='."
;;; Helm update
;;
(defun helm-update (&optional preselect source candidates)
- "Update candidates list in `helm-buffer\\=' based on `helm-pattern\\='.
+ "Update candidates list in `helm-buffer' based on `helm-pattern'.
Argument PRESELECT is a string or regexp used to move selection
to a particular place after finishing update.
When SOURCE is provided update mode-line for this source, otherwise
@@ -4906,7 +4906,7 @@ without recomputing them, it should be a list of lists."
helm-update-blacklist-regexps)))))
(defun helm--update-move-first-line ()
- "Goto first line of `helm-buffer\\='."
+ "Goto first line of `helm-buffer'."
(goto-char (point-min))
(if (helm-window)
(helm-move-selection-common :where 'line
@@ -4919,8 +4919,8 @@ without recomputing them, it should be a list of lists."
(cl-defun helm-force-update (&optional preselect (recenter t))
"Force recalculation and update of candidates.
-Unlike `helm-update\\=', this function re-evaluates `init\\=' and
-`update\\=' attributes when present; also `helm-candidate-cache\\=' is
+Unlike `helm-update', this function re-evaluates `init' and
+`update' attributes when present; also `helm-candidate-cache' is
not reinitialized, meaning candidates are not recomputed unless
pattern has changed.
@@ -4928,7 +4928,7 @@ Selection is preserved to current candidate if it still
exists after
update or moved to PRESELECT, if specified.
The helm-window is re-centered at the end when RECENTER is t which
is the default. RECENTER can be also a number in this case it is
-passed as argument to `recenter\\='."
+passed as argument to `recenter'."
(with-helm-buffer
(let* ((source (helm-get-current-source))
(selection (helm-aif (helm-get-selection nil t source)
@@ -4962,23 +4962,23 @@ passed as argument to `recenter\\='."
(helm-remove-candidate-cache source))
(defun helm-redisplay-buffer ()
- "Redisplay candidates in `helm-buffer\\='.
+ "Redisplay candidates in `helm-buffer'.
Candidates are not recomputed, only redisplayed after modifying
the whole list of candidates in each source with functions found
-in `redisplay\\=' attribute of current source. Note that candidates
+in `redisplay' attribute of current source. Note that candidates
are redisplayed with their display part with all properties
included only. This function is used in async sources to
transform the whole list of candidates from the sentinel
functions (i.e. when all candidates have been computed) because
-other filters like `candidate-transformer\\=' are modifying only
-each chunk of candidates from `process-filter\\=' as they come in
+other filters like `candidate-transformer' are modifying only
+each chunk of candidates from `process-filter' as they come in
and not the whole list. Use this for e.g. sorting the whole list
of async candidates once computed.
Note: To ensure redisplay is done in async sources after Helm
-reached `candidate-number-limit\\=' you will have also to redisplay
-your candidates from `helm-async-outer-limit-hook\\='."
+reached `candidate-number-limit' you will have also to redisplay
+your candidates from `helm-async-outer-limit-hook'."
(with-helm-buffer
(let ((get-cands (lambda (source)
(let ((fns (assoc-default 'redisplay source))
@@ -5020,16 +5020,16 @@ your candidates from `helm-async-outer-limit-hook\\='."
(funcall get-cands s)))))))
(defun helm-remove-candidate-cache (source)
- "Remove SOURCE from `helm-candidate-cache\\='."
+ "Remove SOURCE from `helm-candidate-cache'."
(remhash (assoc-default 'name source) helm-candidate-cache))
(defvar helm-drag-mouse-1-fn 'ignore)
(defun helm-insert-match (match insert-function &optional num source)
- "Insert MATCH into `helm-buffer\\=' with INSERT-FUNCTION.
+ "Insert MATCH into `helm-buffer' with INSERT-FUNCTION.
If MATCH is a cons cell then insert the car as display with the
-cdr stored as real value in a `helm-realvalue\\=' text property.
+cdr stored as real value in a `helm-realvalue' text property.
Args NUM and SOURCE are also stored as text property when
-specified as respectively `helm-cand-num\\=' and `helm-cur-source\\='."
+specified as respectively `helm-cand-num' and `helm-cur-source'."
(let ((start (point-at-bol (point)))
(dispvalue (helm-candidate-get-display match))
(realvalue (cdr-safe match))
@@ -5118,7 +5118,7 @@ specified as respectively `helm-cand-num\\=' and
`helm-cur-source\\='."
(put 'helm-mouse-select-candidate 'helm-only t)
(defun helm-insert-header-from-source (source)
- "Insert SOURCE name in `helm-buffer\\=' header.
+ "Insert SOURCE name in `helm-buffer' header.
Maybe insert, by overlay, additional info after the source name
if SOURCE has header-name attribute."
(let ((name (assoc-default 'name source)))
@@ -5156,10 +5156,10 @@ additional info after the source name by overlay."
(insert "\n"))
(defun helm-init-relative-display-line-numbers ()
- "Enable `display-line-numbers\\=' for Helm buffers.
-This is intended to be added to `helm-after-initialize-hook\\='.
+ "Enable `display-line-numbers' for Helm buffers.
+This is intended to be added to `helm-after-initialize-hook'.
This will work only in Emacs-26+, i.e. Emacs versions that have
-`display-line-numbers-mode\\='."
+`display-line-numbers-mode'."
(when (boundp 'display-line-numbers)
(with-helm-buffer
(setq display-line-numbers 'relative))))
@@ -5182,7 +5182,7 @@ This will work only in Emacs-26+, i.e. Emacs versions
that have
;;; Async process
;;
(defun helm-output-filter (process output-string)
- "The `process-filter\\=' function for Helm async sources."
+ "The `process-filter' function for Helm async sources."
(with-local-quit
(helm-output-filter-1 (assoc process helm-async-processes) output-string)))
@@ -5294,13 +5294,13 @@ function."
(helm-check-minibuffer-input))))))
(defun helm-kill-async-processes ()
- "Kill all asynchronous processes registered in `helm-async-processes\\='."
+ "Kill all asynchronous processes registered in `helm-async-processes'."
(while helm-async-processes
(helm-kill-async-process (caar helm-async-processes))
(setq helm-async-processes (cdr helm-async-processes))))
(defun helm-kill-async-process (process)
- "Stop output from `helm-output-filter\\=' and kill associated PROCESS."
+ "Stop output from `helm-output-filter' and kill associated PROCESS."
(set-process-filter process nil)
(delete-process process))
@@ -5478,7 +5478,7 @@ If action buffer is selected, back to the Helm buffer."
;; Selection of candidates
(defun helm-display-source-at-screen-top-maybe (unit)
- "Display source at the top of screen when UNIT value is \\='source.
+ "Display source at the top of screen when UNIT value is 'source.
Return nil for any other value of UNIT."
(when (and helm-display-source-at-screen-top (eq unit 'source))
(set-window-start (selected-window)
@@ -5486,8 +5486,8 @@ Return nil for any other value of UNIT."
(defun helm-skip-noncandidate-line (direction)
"Skip source header or candidates separator when going in DIRECTION.
-DIRECTION is either \\='next or \\='previous.
-Same as `helm-skip-header-and-separator-line\\=' but ensure point is
+DIRECTION is either 'next or 'previous.
+Same as `helm-skip-header-and-separator-line' but ensure point is
moved to the right place when at bob or eob."
(helm-skip-header-and-separator-line direction)
(and (bobp) (forward-line 1)) ; Skip first header.
@@ -5495,7 +5495,7 @@ moved to the right place when at bob or eob."
(defun helm-skip-header-and-separator-line (direction)
"Skip source header or candidate separator when going to next/previous line.
-DIRECTION is either \\='next or \\='previous."
+DIRECTION is either 'next or 'previous."
(let ((fn (cl-ecase direction
(next 'eobp)
(previous 'bobp))))
@@ -5507,11 +5507,11 @@ DIRECTION is either \\='next or \\='previous."
-1 1)))))
(defun helm-display-mode-line (source &optional force)
- "Set up mode-line and header-line for `helm-buffer\\='.
+ "Set up mode-line and header-line for `helm-buffer'.
SOURCE is a Helm source object.
-Optional argument FORCE forces redisplay of the Helm buffer\\='s
+Optional argument FORCE forces redisplay of the Helm buffer's
mode and header lines."
(set (make-local-variable 'helm-mode-line-string)
(helm-interpret-value (or (and (listp source) ; Check if source is
empty.
@@ -5651,8 +5651,8 @@ This is a toggle command."
(defun helm-hide-minibuffer-maybe ()
"Hide minibuffer contents in a Helm session.
-This function should normally go to `helm-minibuffer-set-up-hook\\='.
-It has no effect if `helm-echo-input-in-header-line\\=' is nil."
+This function should normally go to `helm-minibuffer-set-up-hook'.
+It has no effect if `helm-echo-input-in-header-line' is nil."
(when (with-helm-buffer helm-echo-input-in-header-line)
(let ((ov (make-overlay (point-min) (point-max) nil nil t)))
(overlay-put ov 'window (selected-window))
@@ -5674,7 +5674,7 @@ It has no effect if `helm-echo-input-in-header-line\\='
is nil."
(defun helm-show-candidate-number (&optional name)
"Used to display candidate number in mode-line.
You can specify NAME of candidates e.g. \"Buffers\" otherwise it
-is \"Candidate(s)\" by default."
+is \"Candidate\(s\)\" by default."
(when helm-alive-p
(unless (helm-empty-source-p)
;; Build a fixed width string when candidate-number < 1000
@@ -5700,7 +5700,7 @@ Key arg WHERE can be one of:
Key arg DIRECTION can be one of:
- previous
- next
- - A source or a source name when used with :WHERE \\='source."
+ - A source or a source name when used with :WHERE 'source."
(let ((move-func (cl-case where
(line (cl-ecase direction
(previous 'helm-move--previous-line-fn)
@@ -5869,7 +5869,7 @@ Key arg DIRECTION can be one of:
(defun helm-previous-line (&optional arg)
"Move selection to the ARG previous line(s).
-Same behavior as `helm-next-line\\=' when called with a numeric
+Same behavior as `helm-next-line' when called with a numeric
prefix arg."
(interactive "p")
(with-helm-alive-p
@@ -5879,7 +5879,7 @@ prefix arg."
(defun helm-next-line (&optional arg)
"Move selection to the next ARG line(s).
When numeric prefix arg is > than the number of candidates, then
-move to the last candidate of current source (i.e. don\\='t move to
+move to the last candidate of current source (i.e. don't move to
next source)."
(interactive "p")
(with-helm-alive-p
@@ -5887,7 +5887,7 @@ next source)."
(put 'helm-next-line 'helm-only t)
(defun helm-scroll-up ()
- "Scroll up helm-buffer by `helm-scroll-amount\\=' lines."
+ "Scroll up helm-buffer by `helm-scroll-amount' lines."
(interactive)
(with-helm-alive-p
(helm-move-selection-common :where 'page :direction 'previous)))
@@ -5902,7 +5902,7 @@ next source)."
(put 'helm-previous-page 'helm-only t)
(defun helm-scroll-down ()
- "Scroll down helm-buffer by `helm-scroll-amount\\=' lines."
+ "Scroll down helm-buffer by `helm-scroll-amount' lines."
(interactive)
(with-helm-alive-p
(helm-move-selection-common :where 'page :direction 'next)))
@@ -5956,8 +5956,8 @@ candidate of first source."
helm-ff-increase-image-size-persistent
helm-ff-rotate-left-persistent
helm-ff-rotate-right-persistent)
- "Allow `helm-follow-action-forward/backward\\=' switching to next file
-when one of these commands is the `last-command\\='.
+ "Allow `helm-follow-action-forward/backward' switching to next file
+when one of these commands is the `last-command'.
For example when browsing files with `C-<down>` and rotate the current file,
hitting `C-<down>` again will not switch to next file but kill its buffer.")
@@ -5995,8 +5995,8 @@ hitting `C-<down>` again will not switch to next file but
kill its buffer.")
(put 'helm-follow-action-backward 'helm-only t)
(defun helm-mark-current-line (&optional resumep nomouse)
- "Move `helm-selection-overlay\\=' to current line.
-When RESUMEP is non nil move overlay to `helm-selection-point\\='.
+ "Move `helm-selection-overlay' to current line.
+When RESUMEP is non nil move overlay to `helm-selection-point'.
When NOMOUSE is specified do not set mouse bindings.
Note that selection is unrelated to visible marks used for
@@ -6022,11 +6022,11 @@ marking candidates."
(defun helm-confirm-and-exit-minibuffer ()
"Maybe ask for confirmation when exiting helm.
-It is similar to `minibuffer-complete-and-exit\\=' adapted to Helm.
-If `minibuffer-completion-confirm\\=' value is \\='confirm, send
+It is similar to `minibuffer-complete-and-exit' adapted to Helm.
+If `minibuffer-completion-confirm' value is 'confirm, send
minibuffer confirm message and exit on next hit. If
-`minibuffer-completion-confirm\\=' value is t, don\\='t exit and send
-message \\='no match\\='."
+`minibuffer-completion-confirm' value is t, don't exit and send
+message 'no match'."
(interactive)
(with-helm-alive-p
(if (and (helm--updating-p)
@@ -6075,7 +6075,7 @@ message \\='no match\\='."
(put 'helm-confirm-and-exit-minibuffer 'helm-only t)
(defun helm-confirm-and-exit-hook ()
- "Restore `minibuffer-completion-confirm\\=' when helm update."
+ "Restore `minibuffer-completion-confirm' when helm update."
(unless (or (eq minibuffer-completion-confirm t)
(not helm-minibuffer-confirm-state))
(setq minibuffer-completion-confirm
@@ -6089,7 +6089,7 @@ message \\='no match\\='."
(defun helm-read-string (prompt &optional initial-input history
default-value inherit-input-method)
- "Same as `read-string\\=' but for reading string from a helm session."
+ "Same as `read-string' but for reading string from a helm session."
(let ((helm--reading-passwd-or-string t))
(read-string
prompt initial-input history default-value inherit-input-method)))
@@ -6142,7 +6142,7 @@ If action buffer is displayed, kill it."
(previous-single-property-change (point) 'helm-header))
(defun helm-pos-multiline-p ()
- "Return non-`nil\\=' if the current position is in the multiline source
region."
+ "Return non-`nil' if the current position is in the multiline source region."
(get-text-property (point) 'helm-multiline))
(defun helm-get-next-candidate-separator-pos ()
@@ -6329,7 +6329,7 @@ Used generally to modify current selection."
(defun helm-delete-minibuffer-contents (&optional arg)
"Delete minibuffer contents.
-When `helm-delete-minibuffer-contents-from-point\\=' is non-nil,
+When `helm-delete-minibuffer-contents-from-point' is non-nil,
delete minibuffer contents from point instead of deleting all.
With a prefix arg reverse this behaviour. When at the end of
minibuffer, delete all."
@@ -6347,10 +6347,10 @@ minibuffer, delete all."
;;; helm-source-in-buffer.
;;
(defun helm-candidates-in-buffer (&optional source)
- "The top level function used to store candidates with
`helm-source-in-buffer\\='.
+ "The top level function used to store candidates with
`helm-source-in-buffer'.
Candidates are stored in a buffer generated internally by
-`helm-candidate-buffer\\=' function. Each candidate must be placed
+`helm-candidate-buffer' function. Each candidate must be placed
in one line.
The buffer is created and fed in the init attribute function of
@@ -6361,50 +6361,50 @@ E.g.:
(helm-build-in-buffer-source \"test\"
:init (lambda ()
(helm-init-candidates-in-buffer
- \\='global \\='(foo foa fob bar baz))))
+ 'global '(foo foa fob bar baz))))
A shortcut can be used to simplify:
(helm-build-in-buffer-source \"test\"
- :data \\='(foo foa fob bar baz))
+ :data '(foo foa fob bar baz))
By default, Helm makes candidates by evaluating the candidates
-function, then narrows them by `string-match\\=' for each candidate.
+function, then narrows them by `string-match' for each candidate.
But this is slow for large number of candidates. The new way is
to store all candidates in a buffer and then narrow with
-`re-search-forward\\='. Search function is customizable by search
+`re-search-forward'. Search function is customizable by search
attribute. The important point is that buffer processing is MUCH
FASTER than string list processing and is the Emacs way.
The init function writes all candidates to a newly-created
candidate buffer. The candidates buffer is created or specified
-by `helm-candidate-buffer\\='. Candidates are stored in a line.
+by `helm-candidate-buffer'. Candidates are stored in a line.
The candidates function narrows all candidates, IOW creates a
subset of candidates dynamically.
-Class `helm-source-in-buffer\\=' is implemented with three attributes:
+Class `helm-source-in-buffer' is implemented with three attributes:
(candidates . helm-candidates-in-buffer)
(volatile)
(match identity)
The volatile attribute is needed because
-`helm-candidates-in-buffer\\=' creates candidates dynamically and
-need to be called every time `helm-pattern\\=' changes.
+`helm-candidates-in-buffer' creates candidates dynamically and
+need to be called every time `helm-pattern' changes.
-Because `helm-candidates-in-buffer\\=' plays the role of `match\\='
-attribute function, specifying `(match identity)\\=' makes the
+Because `helm-candidates-in-buffer' plays the role of `match'
+attribute function, specifying `(match identity)' makes the
source slightly faster.
-However if source contains `match-part\\=' attribute, match is
+However if source contains `match-part' attribute, match is
computed only on part of candidate returned by the call of
function provided by this attribute. The function should have one
arg, candidate, and return only a specific part of candidate.
-To customize `helm-candidates-in-buffer\\=' behaviour, use `search\\=',
-`get-line\\=' and `match-part\\=' attributes."
+To customize `helm-candidates-in-buffer' behaviour, use `search',
+`get-line' and `match-part' attributes."
(let ((src (or source (helm-get-current-source))))
(helm-candidates-in-buffer-1
(helm-candidate-buffer)
@@ -6418,7 +6418,7 @@ To customize `helm-candidates-in-buffer\\=' behaviour,
use `search\\=',
src)))
(defun helm-candidates-in-buffer-search-default-fn (pattern)
- "Search PATTERN with `re-search-forward\\=' with bound and noerror args."
+ "Search PATTERN with `re-search-forward' with bound and noerror args."
(condition-case _err
(re-search-forward pattern nil t)
(invalid-regexp nil)))
@@ -6509,9 +6509,9 @@ To customize `helm-candidates-in-buffer\\=' behaviour,
use `search\\=',
(defun helm-search-match-part (candidate pattern diacritics)
"Match PATTERN only on match-part property value of CANDIDATE.
-Because `helm-search-match-part\\=' may be called even if
+Because `helm-search-match-part' may be called even if
unspecified in source (negation or fuzzy), the part to match
-falls back to the whole candidate even if match-part hasn\\='t been
+falls back to the whole candidate even if match-part hasn't been
computed by match-part-fn and stored in the match-part property."
(let ((part (or (get-text-property 0 'match-part candidate)
candidate))
@@ -6563,24 +6563,24 @@ computed by match-part-fn and stored in the match-part
property."
This is used to initialize a buffer for storing candidates for a
candidates-in-buffer source, candidates will be searched in this
-buffer and displayed in `helm-buffer\\='. This should be used only
-in init functions, don\\='t relay on this in other places unless you
+buffer and displayed in `helm-buffer'. This should be used only
+in init functions, don't relay on this in other places unless you
know what you are doing.
This function is still in public API only for backward
compatibility, you should use instead
-`helm-init-candidates-in-buffer\\=' for initializing your sources.
+`helm-init-candidates-in-buffer' for initializing your sources.
Internally, this function is called without argument and returns
the buffer corresponding to current source i.e.
-`helm--source-name\\=' which is available in only some places.
+`helm--source-name' which is available in only some places.
Acceptable values of BUFFER-SPEC:
- global (a symbol)
Create a new global candidates buffer,
named \" *helm candidates:SOURCE*\".
- This is used by `helm-init-candidates-in-buffer\\=' and it is
+ This is used by `helm-init-candidates-in-buffer' and it is
the most common usage of BUFFER-SPEC.
The buffer will be killed and recreated at each new
helm-session.
@@ -6590,9 +6590,9 @@ Acceptable values of BUFFER-SPEC:
named \" *helm candidates:SOURCE*HELM-CURRENT-BUFFER\".
You may want to use this when you want to have a different
buffer each time source is used from a different
- `helm-current-buffer\\='.
+ `helm-current-buffer'.
The buffer is erased and refilled at each new session but not
- killed. You probably don\\='t want to use this value for
+ killed. You probably don't want to use this value for
BUFFER-SPEC.
- nil (omit)
@@ -6604,7 +6604,7 @@ Acceptable values of BUFFER-SPEC:
This allow you to use the buffer as a cache, it is faster
because the buffer is already drawn, but be careful when using
this as you may mangle your buffer depending on what you write
- in your init(s) function, IOW don\\='t modify the contents of the
+ in your init(s) function, IOW don't modify the contents of the
buffer in init(s) function but in a transformer.
The buffer is not erased nor deleted.
Generally it is safer to use a copy of buffer inserted
@@ -6664,26 +6664,26 @@ before running again the init function."
(defvar helm-candidate-buffer-longest-len 0
"May store the longest length of candidates in a in-buffer source.
-It is a local variable set from `helm-init-candidates-in-buffer\\=' in
-`helm-candidate-buffer\\='.
+It is a local variable set from `helm-init-candidates-in-buffer' in
+`helm-candidate-buffer'.
Allow getting the longest length of initial candidates in transformers
without looping again through the whole list.")
(defun helm-init-candidates-in-buffer (buffer-spec data)
"Register BUFFER-SPEC with DATA for a helm candidates-in-buffer session.
-Arg BUFFER-SPEC can be a `buffer-name\\=' (stringp), a buffer-spec
-object (bufferp), or a symbol, either \\='local or \\='global which is
-passed to `helm-candidate-buffer\\='.
-The most common usage of BUFFER-SPEC is \\='global.
+Arg BUFFER-SPEC can be a `buffer-name' (stringp), a buffer-spec
+object \(bufferp), or a symbol, either 'local or 'global which is
+passed to `helm-candidate-buffer'.
+The most common usage of BUFFER-SPEC is 'global.
Arg DATA can be either a list or a plain string.
Returns the resulting buffer.
Use this in your init function to register a buffer for a
-`helm-source-in-buffer\\=' session and feed it with DATA. You
-probably don\\='t want to bother with this and use the :data slot
-when initializing a source with `helm-source-in-buffer\\=' class."
+`helm-source-in-buffer' session and feed it with DATA. You
+probably don't want to bother with this and use the :data slot
+when initializing a source with `helm-source-in-buffer' class."
(declare (indent 1))
(let ((caching (and (or (stringp buffer-spec)
(bufferp buffer-spec))
@@ -6778,7 +6778,7 @@ If N is positive enlarge, if negative narrow."
(put 'helm-enlarge-window 'helm-only t)
(defun helm-toggle-full-frame (&optional arg)
- "Toggle `helm-buffer\\=' full-frame view."
+ "Toggle `helm-buffer' full-frame view."
(interactive "p")
(cl-assert (null (helm-action-window))
nil "Unable to toggle full frame from action window")
@@ -6802,7 +6802,7 @@ If N is positive enlarge, if negative narrow."
(put 'helm-toggle-full-frame 'helm-only t)
(defun helm-swap-windows ()
- "Swap window holding `helm-buffer\\=' with other window."
+ "Swap window holding `helm-buffer' with other window."
(interactive)
(with-helm-alive-p
(if (= (length (window-list nil 1)) 2)
@@ -6850,8 +6850,8 @@ If N is positive enlarge, if negative narrow."
(put 'helm-swap-windows 'helm-only t)
(defun helm--get-window-side-state ()
- "Return the position of `helm-window\\=' from `helm-current-buffer\\='.
-Possible values are \\='left \\='right \\='below or \\='above."
+ "Return the position of `helm-window' from `helm-current-buffer'.
+Possible values are 'left 'right 'below or 'above."
(let ((side-list '(left right below above)))
(cl-loop for side in side-list
thereis (and (equal (helm-window)
@@ -6909,16 +6909,16 @@ Possible values are \\='left \\='right \\='below or
\\='above."
(cl-defun helm-execute-persistent-action (&optional attr split)
"Perform the associated action ATTR without quitting helm.
-Arg ATTR default will be `persistent-action\\=' or
-`persistent-action-if\\=' if unspecified depending on what\\='s found
+Arg ATTR default will be `persistent-action' or
+`persistent-action-if' if unspecified depending on what's found
in source, but it can be anything else.
In this case you have to add this new attribute to your source.
-See `persistent-action\\=' and `persistent-action-if\\=' slot
-documentation in `helm-source\\='.
+See `persistent-action' and `persistent-action-if' slot
+documentation in `helm-source'.
-When `helm-full-frame\\=' is non-nil, and `helm-buffer\\=' is displayed
+When `helm-full-frame' is non-nil, and `helm-buffer' is displayed
in only one window, the helm window is split to display
-`helm-select-persistent-action-window\\=' in other window to
+`helm-select-persistent-action-window' in other window to
maintain visibility. The argument SPLIT can be used to force
splitting inconditionally, it is unused actually."
(interactive)
@@ -6982,8 +6982,8 @@ splitting inconditionally, it is unused actually."
(cl-defun helm-persistent-action-display-window (&key split)
"Return the window that will be used for persistent action.
If SPLIT is t window is split in persistent action, if it has the
-special symbol `never\\=' don\\='t split, if it is nil don\\='t split either.
-The symbol `never\\=' is kept for backward compatibility."
+special symbol `never' don't split, if it is nil don't split either.
+The symbol `never' is kept for backward compatibility."
(with-helm-window
(setq helm-persistent-action-display-window
(cond ((and (window-live-p helm-persistent-action-display-window)
@@ -6998,7 +6998,7 @@ The symbol `never\\=' is kept for backward compatibility."
(cl-defun helm-select-persistent-action-window (&key split)
"Select the window that will be used for persistent action.
-See `helm-persistent-action-display-window\\=' for how to use SPLIT."
+See `helm-persistent-action-display-window' for how to use SPLIT."
(select-window (get-buffer-window (helm-buffer-get)))
(prog1
(select-window
@@ -7016,23 +7016,23 @@ See `helm-persistent-action-display-window\\=' for how
to use SPLIT."
(defun helm-scroll-other-window (&optional arg)
"Scroll other window upward ARG many lines.
-When arg is not provided scroll `helm-scroll-amount\\=' lines.
-See `scroll-other-window\\='."
+When arg is not provided scroll `helm-scroll-amount' lines.
+See `scroll-other-window'."
(interactive "P")
(with-helm-alive-p (helm-other-window-base 'scroll-other-window arg)))
(put 'helm-scroll-other-window 'helm-only t)
(defun helm-scroll-other-window-down (&optional arg)
"Scroll other window downward ARG many lines.
-When arg is not provided scroll `helm-scroll-amount\\=' lines.
-See `scroll-other-window-down\\='."
+When arg is not provided scroll `helm-scroll-amount' lines.
+See `scroll-other-window-down'."
(interactive "P")
(with-helm-alive-p (helm-other-window-base 'scroll-other-window-down arg)))
(put 'helm-scroll-other-window-down 'helm-only t)
(defun helm-recenter-top-bottom-other-window (&optional arg)
- "Run `recenter-top-bottom\\=' in other window.
-Meaning of prefix ARG is the same as in `recenter-top-bottom\\='."
+ "Run `recenter-top-bottom' in other window.
+Meaning of prefix ARG is the same as in `recenter-top-bottom'."
(interactive "P")
(with-helm-alive-p
(with-helm-window
@@ -7041,8 +7041,8 @@ Meaning of prefix ARG is the same as in
`recenter-top-bottom\\='."
(put 'helm-recenter-top-bottom-other-window 'helm-only t)
(defun helm-reposition-window-other-window (&optional arg)
- "Run `reposition-window\\=' in other window.
-Meaning of prefix ARG is the same as in `reposition-window\\='."
+ "Run `reposition-window' in other window.
+Meaning of prefix ARG is the same as in `reposition-window'."
(interactive "P")
(with-helm-alive-p
(with-helm-window
@@ -7178,7 +7178,7 @@ sources."
(defun helm-mark-all-1 (&optional ensure-beg-of-source)
"Mark all visible unmarked candidates in current source.
-Need to be wrapped in `with-helm-window\\='.
+Need to be wrapped in `with-helm-window'.
Arg ENSURE-BEG-OF-SOURCE ensure we are at beginning of source
when starting to mark candidates, if handled elsewhere before
starting it is not needed."
@@ -7426,7 +7426,7 @@ With a prefix arg set to real value of current selection."
(defun helm-kill-selection-and-quit (arg)
"Store display value of current selection to kill ring.
With a prefix arg use real value of current selection.
-Display value is shown in `helm-buffer\\=' and real value is used to
+Display value is shown in `helm-buffer' and real value is used to
perform actions."
(interactive "P")
(with-helm-alive-p
@@ -7462,8 +7462,8 @@ The real value of each candidate is used."
;;
;;
(defvar helm-follow-input-idle-delay nil
- "`helm-follow-mode\\=' will execute its persistent action after this delay.
-Note that if the `follow-delay\\=' attr is present in source, it
+ "`helm-follow-mode' will execute its persistent action after this delay.
+Note that if the `follow-delay' attr is present in source, it
will take precedence over this.")
(defun helm-follow-mode (&optional arg)
@@ -7474,21 +7474,21 @@ This mode is source local, i.e. It applies on current
source only.
This mode can be enabled or disabled interactively at anytime during
a helm session with \\[helm-follow-mode].
-When enabling interactively `helm-follow-mode\\=' in a source, you
+When enabling interactively `helm-follow-mode' in a source, you
can keep it enabled for next Emacs sessions by setting
-`helm-follow-mode-persistent\\=' to a non-nil value.
+`helm-follow-mode-persistent' to a non-nil value.
-When `helm-follow-mode\\=' is called with a prefix arg and
-`helm-follow-mode-persistent\\=' is non-nil `helm-follow-mode\\=' will
+When `helm-follow-mode' is called with a prefix arg and
+`helm-follow-mode-persistent' is non-nil `helm-follow-mode' will
be persistent only for this Emacs session, but not for the next
Emacs sessions, i.e. the current source will not be saved to
-`helm-source-names-using-follow\\='.
+`helm-source-names-using-follow'.
-A prefix arg with `helm-follow-mode\\=' already enabled will have no
+A prefix arg with `helm-follow-mode' already enabled will have no
effect.
Note that you can use instead of this mode the commands
-`helm-follow-action-forward\\=' and `helm-follow-action-backward\\=' at
+`helm-follow-action-forward' and `helm-follow-action-backward' at
anytime in all Helm sessions.
They are bound by default to \\[helm-follow-action-forward] and
@@ -7538,11 +7538,11 @@ They are bound by default to
\\[helm-follow-action-forward] and
(put 'helm-follow-mode 'helm-only t)
(defun helm-follow-execute-persistent-action-maybe (&optional delay)
- "Execute persistent action in mode `helm-follow-mode\\='.
+ "Execute persistent action in mode `helm-follow-mode'.
-This happen after: DELAY or the \\='follow-attr value of current
-source or `helm-follow-input-idle-delay\\=' or
-`helm-input-idle-delay\\=' secs."
+This happen after: DELAY or the 'follow-attr value of current
+source or `helm-follow-input-idle-delay' or
+`helm-input-idle-delay' secs."
(let* ((src (helm-get-current-source))
(at (or delay
(assoc-default 'follow-delay src)
@@ -7586,11 +7586,11 @@ source or `helm-follow-input-idle-delay\\=' or
(define-minor-mode helm-autoresize-mode
"Auto resize helm window when enabled.
-Helm window is re-sized according to `helm-autoresize-max-height\\='
-and `helm-autoresize-min-height\\='. Note that when this mode is
-enabled, Helm behaves as if `helm-always-two-windows\\=' is enabled.
+Helm window is re-sized according to `helm-autoresize-max-height'
+and `helm-autoresize-min-height'. Note that when this mode is
+enabled, Helm behaves as if `helm-always-two-windows' is enabled.
-See `fit-window-to-buffer\\=' for more infos."
+See `fit-window-to-buffer' for more infos."
:group 'helm
:global t
(if helm-autoresize-mode
@@ -7600,13 +7600,13 @@ See `fit-window-to-buffer\\=' for more infos."
(remove-hook 'helm-window-configuration-hook 'helm--autoresize-hook)))
(defun helm-help ()
- "Generate Helm\\='s help according to `help-message\\=' attribute.
+ "Generate Helm's help according to `help-message' attribute.
-If `helm-buffer\\=' is empty, provide completions on `helm-sources\\='
+If `helm-buffer' is empty, provide completions on `helm-sources'
to choose its local documentation.
-If source doesn\\='t have any `help-message\\=' attribute, a generic
+If source doesn't have any `help-message' attribute, a generic
message explaining this is added instead.
-The global `helm-help-message\\=' is always added after this local
+The global `helm-help-message' is always added after this local
help."
(interactive)
(require 'helm-mode) ; for helm-comp-read.
@@ -7633,7 +7633,7 @@ help."
(put 'helm-help 'helm-only t)
(defun helm-toggle-truncate-line ()
- "Toggle `truncate-lines\\=' value in `helm-buffer\\='"
+ "Toggle `truncate-lines' value in `helm-buffer'"
(interactive)
(with-helm-alive-p
(with-helm-buffer
diff --git a/helm-dabbrev.el b/helm-dabbrev.el
index dffa1d2610..bd1deb6653 100644
--- a/helm-dabbrev.el
+++ b/helm-dabbrev.el
@@ -30,7 +30,7 @@
"Always search in all buffers when non--nil.
Note that even if nil, a search in all buffers will occur if the
length of candidates is <= than
-`helm-dabbrev-max-length-result\\='."
+`helm-dabbrev-max-length-result'."
:group 'helm-dabbrev
:type 'boolean)
@@ -41,29 +41,29 @@ The higher this number is, the slower the computation of
candidates will be. You can use safely a higher value with
emacs-26+.
Note that this have nothing to do with
-`helm-candidate-number-limit\\=', this means that computation of
+`helm-candidate-number-limit', this means that computation of
candidates stop when this value is reached but only
-`helm-candidate-number-limit\\=' candidates are displayed in the
+`helm-candidate-number-limit' candidates are displayed in the
Helm buffer."
:group 'helm-dabbrev
:type 'integer)
(defcustom helm-dabbrev-ignored-buffers-regexps
'("\\*helm" "\\*Messages" "\\*Echo Area" "\\*Buffer List")
- "List of regexps matching names of buffers that `helm-dabbrev\\=' should not
check."
+ "List of regexps matching names of buffers that `helm-dabbrev' should not
check."
:group 'helm-dabbrev
:type '(repeat regexp))
(defcustom helm-dabbrev-related-buffer-fn #'helm-dabbrev--same-major-mode-p
- "A function that decide if a buffer to search in its related to
`current-buffer\\='.
+ "A function that decide if a buffer to search in its related to
`current-buffer'.
-This is actually determined by comparing `major-mode\\=' of the
-buffer to search and the `current-buffer\\='.
+This is actually determined by comparing `major-mode' of the
+buffer to search and the `current-buffer'.
The function take one arg, the buffer which is current, look at
-`helm-dabbrev--same-major-mode-p\\=' for an example.
+`helm-dabbrev--same-major-mode-p' for an example.
-When nil all buffers are considered related to `current-buffer\\='."
+When nil all buffers are considered related to `current-buffer'."
:group 'helm-dabbrev
:type 'function)
@@ -71,19 +71,19 @@ When nil all buffers are considered related to
`current-buffer\\='."
"Major mode association alist.
This allow helm-dabbrev searching in buffers with the associated
-`major-mode\\='.
-E.g. (emacs-lisp-mode . lisp-interaction-mode)
+`major-mode'.
+E.g. \(emacs-lisp-mode . lisp-interaction-mode\)
will allow searching in the lisp-interaction-mode buffer when
-`current-buffer\\=' is an `emacs-lisp-mode\\=' buffer and vice versa
-i.e. no need to provide (lisp-interaction-mode .
-emacs-lisp-mode) association.
+`current-buffer' is an `emacs-lisp-mode' buffer and vice versa
+i.e. no need to provide \(lisp-interaction-mode .
+emacs-lisp-mode\) association.
-When nil check is the searched buffer has same `major-mode\\=' than
-the `current-buffer\\='.
+When nil check is the searched buffer has same `major-mode' than
+the `current-buffer'.
-This has no effect when `helm-dabbrev-related-buffer-fn\\=' is nil
-or of course bound to a function that doesn\\='t handle this var."
+This has no effect when `helm-dabbrev-related-buffer-fn' is nil
+or of course bound to a function that doesn't handle this var."
:type '(alist :key-type symbol :value-type symbol)
:group 'helm-dabbrev)
@@ -99,8 +99,8 @@ When nil or 0 disable cycling."
:type '(choice (const :tag "Cycling disabled" nil) integer))
(defcustom helm-dabbrev-case-fold-search 'smart
- "Set `case-fold-search\\=' in `helm-dabbrev\\='.
-Same as `helm-case-fold-search\\=' but for `helm-dabbrev\\='.
+ "Set `case-fold-search' in `helm-dabbrev'.
+Same as `helm-case-fold-search' but for `helm-dabbrev'.
Note that this is not affecting searching in Helm buffer, but the
initial search for all candidates in buffer(s)."
:group 'helm-dabbrev
@@ -202,10 +202,10 @@ Argument DIRECTION can be:
- (1): Search forward from point.
- (-1): Search backward from point.
- (2): Search forward from the
- `helm-dabbrev-lineno-around\\='
+ `helm-dabbrev-lineno-around'
lines after point.
- (-2): Search backward from the
- `helm-dabbrev-lineno-around\\='
+ `helm-dabbrev-lineno-around'
lines before point."
(let ((res results)
after before)
@@ -238,10 +238,10 @@ Argument DIRECTION can be:
(defun helm-dabbrev--search (pattern beg sep-regexp)
"Search word or symbol at point matching PATTERN.
-Argument BEG is corresponding to the previous `match-beginning\\='
+Argument BEG is corresponding to the previous `match-beginning'
search.
The search starts at (1- BEG) with a regexp starting with
-`helm-dabbrev-separator-regexp\\=' followed by PATTERN followed by a
+`helm-dabbrev-separator-regexp' followed by PATTERN followed by a
regexp matching syntactically any word or symbol.
The possible false positives matching SEP-REGEXP at end are
finally removed."
diff --git a/helm-elisp-package.el b/helm-elisp-package.el
index 448fc7d0ed..258253a759 100644
--- a/helm-elisp-package.el
+++ b/helm-elisp-package.el
@@ -35,7 +35,7 @@
(const :tag "Show upgradable packages" upgrade)))
(defcustom helm-el-truncate-lines t
- "Truncate lines in `helm-buffer\\=' when non-nil."
+ "Truncate lines in `helm-buffer' when non-nil."
:group 'helm-el-package
:type 'boolean)
@@ -47,7 +47,7 @@
(defcustom helm-el-package-autoremove-on-start nil
"Try to autoremove no more needed packages on startup.
-See `package-autoremove\\='."
+See `package-autoremove'."
:group 'helm-el-package
:type 'boolean)
@@ -472,7 +472,7 @@ See `package-autoremove\\='."
;;;###autoload
(defun helm-list-elisp-packages (arg)
- "Preconfigured `helm\\=' for listing and handling Emacs packages."
+ "Preconfigured `helm' for listing and handling Emacs packages."
(interactive "P")
(when arg (setq helm-el-package--initialized-p nil))
(unless helm-source-list-el-package
@@ -487,7 +487,7 @@ See `package-autoremove\\='."
(defun helm-list-elisp-packages-no-fetch (arg)
"Preconfigured Helm for Emacs packages.
-Same as `helm-list-elisp-packages\\=' but don\\='t fetch packages on
+Same as `helm-list-elisp-packages' but don't fetch packages on
remote. Called with a prefix ARG always fetch packages on
remote."
(interactive "P")
diff --git a/helm-elisp.el b/helm-elisp.el
index 65fdf81fa1..0fb51a9815 100644
--- a/helm-elisp.el
+++ b/helm-elisp.el
@@ -41,13 +41,13 @@
:group 'helm)
(defcustom helm-turn-on-show-completion t
- "Display candidate in `current-buffer\\=' while moving selection when
non--nil."
+ "Display candidate in `current-buffer' while moving selection when non--nil."
:group 'helm-elisp
:type 'boolean)
(defcustom helm-show-completion-min-window-height 7
"Minimum completion window height used in show completion.
-This is used in macro `with-helm-show-completion\\='."
+This is used in macro `with-helm-show-completion'."
:group 'helm-elisp
:type 'integer)
@@ -56,7 +56,7 @@ This is used in macro `with-helm-show-completion\\='."
callf callf2 cl-callf cl-callf2 fset
fboundp fmakunbound symbol-function)
"List of function where quoted function completion happen.
-E.g. give only function names after (funcall \\='."
+E.g. give only function names after (funcall '."
:group 'helm-elisp
:type '(repeat (choice symbol)))
@@ -68,7 +68,7 @@ E.g. give only function names after (function ."
:type '(repeat (choice symbol)))
(defcustom helm-apropos-fuzzy-match nil
- "Enable fuzzy matching for `helm-apropos\\=' when non-nil."
+ "Enable fuzzy matching for `helm-apropos' when non-nil."
:group 'helm-elisp
:type 'boolean)
@@ -76,7 +76,7 @@ E.g. give only function names after (function ."
"Enable fuzzy matching in emacs-lisp completion when non-nil.
NOTE: This enables fuzzy matching in Helm native implementation of
elisp completion, but not on helmized elisp completion, i.e. fuzzy
-completion is not available in `completion-at-point\\='."
+completion is not available in `completion-at-point'."
:group 'helm-elisp
:type 'boolean)
@@ -86,7 +86,7 @@ completion is not available in `completion-at-point\\='."
helm-def-source--eieio-generic
helm-def-source--emacs-variables
helm-def-source--emacs-faces)
- "A list of functions that build helm sources to use in `helm-apropos\\='."
+ "A list of functions that build helm sources to use in `helm-apropos'."
:group 'helm-elisp
:type '(repeat (choice symbol)))
@@ -103,11 +103,11 @@ completion is not available in `completion-at-point\\='."
#'helm-show-completion-default-display-function)
"The function used to display helm completion buffer.
-This function is used by `with-helm-show-completion\\=', when nil
-fallback to `helm-default-display-buffer\\='.
+This function is used by `with-helm-show-completion', when nil
+fallback to `helm-default-display-buffer'.
Default is to use a separate frame on graphic display and
-`helm-show-completion-default-display-function\\=' on non graphic
+`helm-show-completion-default-display-function' on non graphic
display."
:group 'helm-elisp
:type 'function)
@@ -124,13 +124,13 @@ display."
(defface helm-lisp-show-completion
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:background "DarkSlateGray"))
- "Face used for showing candidates in `helm-lisp-completion\\='."
+ "Face used for showing candidates in `helm-lisp-completion'."
:group 'helm-elisp-faces)
(defface helm-lisp-completion-info
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "red"))
- "Face used for showing info in `helm-lisp-completion\\='."
+ "Face used for showing info in `helm-lisp-completion'."
:group 'helm-elisp-faces)
(defcustom helm-elisp-help-function
@@ -143,7 +143,7 @@ display."
helm-elisp-show-doc-modeline)))
(defcustom helm-locate-library-fuzzy-match t
- "Enable fuzzy-matching in `helm-locate-library\\=' when non--nil."
+ "Enable fuzzy-matching in `helm-locate-library' when non--nil."
:type 'boolean
:group 'helm-elisp)
@@ -188,9 +188,9 @@ display."
(defmacro with-helm-show-completion (beg end &rest body)
"Show Helm candidate in an overlay at point.
BEG and END are the beginning and end position of the current
-completion in `helm-current-buffer\\='.
+completion in `helm-current-buffer'.
BODY is an Helm call where we want to enable show completion.
-If `helm-turn-on-show-completion\\=' is nil do nothing."
+If `helm-turn-on-show-completion' is nil do nothing."
(declare (indent 2) (debug t))
`(unwind-protect
(if helm-turn-on-show-completion
@@ -273,8 +273,8 @@ of symbol before point."
(buffer-substring-no-properties beg end))))))
(defun helm-bounds-of-thing-before-point (&optional regexp)
- "Get the beginning and end position of `helm-thing-before-point\\='.
-Return a cons (beg . end)."
+ "Get the beginning and end position of `helm-thing-before-point'.
+Return a cons \(beg . end\)."
(helm-thing-before-point 'limits regexp))
(defun helm-insert-completion-at-point (beg end str)
@@ -350,11 +350,11 @@ Return a cons (beg . end)."
"Show documentation for the function.
Documentation is shown briefly in mode-line or completely in
other window according to the value of
-`helm-elisp-help-function\\='."
+`helm-elisp-help-function'."
(funcall helm-elisp-help-function candidate name))
(defun helm-lisp-completion-persistent-help ()
- "Return persistent-help according to the value of
`helm-elisp-help-function\\='"
+ "Return persistent-help according to the value of `helm-elisp-help-function'"
(cl-ecase helm-elisp-help-function
(helm-elisp-show-doc-modeline "Show brief doc in mode-line")
(helm-elisp-show-help "Toggle show help for the symbol")))
@@ -498,7 +498,7 @@ double quote."
(defvar helm-apropos-history nil)
(defun helm-apropos-init (test default)
- "Init candidates buffer for `helm-apropos\\=' sources."
+ "Init candidates buffer for `helm-apropos' sources."
(require 'helm-help)
(helm-init-candidates-in-buffer 'global
(let ((default-symbol (and (stringp default)
@@ -509,7 +509,7 @@ double quote."
symbols))))
(defun helm-apropos-init-faces (default)
- "Init candidates buffer for faces for `helm-apropos\\='."
+ "Init candidates buffer for faces for `helm-apropos'."
(require 'helm-help)
(with-current-buffer (helm-candidate-buffer 'global)
(goto-char (point-min))
@@ -607,8 +607,8 @@ double quote."
:action-transformer 'helm-apropos-action-transformer))
(defun helm-def-source--emacs-faces (&optional default)
- "Create `helm\\=' source for faces to be displayed with
-`helm-apropos\\='."
+ "Create `helm' source for faces to be displayed with
+`helm-apropos'."
(helm-build-in-buffer-source "Faces"
:init (lambda () (helm-apropos-init-faces default))
:fuzzy-match helm-apropos-fuzzy-match
@@ -747,7 +747,7 @@ double quote."
(defun helm-apropos (default)
"Preconfigured Helm to describe commands, functions, variables and faces.
In non interactives calls DEFAULT argument should be provided as
-a string, i.e. the `symbol-name\\=' of any existing symbol."
+a string, i.e. the `symbol-name' of any existing symbol."
(interactive (list (with-syntax-table emacs-lisp-mode-syntax-table
(thing-at-point 'symbol))))
(let (helm-M-x-show-short-doc)
@@ -823,7 +823,7 @@ a string, i.e. the `symbol-name\\=' of any existing symbol."
;;;###autoload
(defun helm-manage-advice ()
- "Preconfigured `helm\\=' to disable/enable function advices."
+ "Preconfigured `helm' to disable/enable function advices."
(interactive)
(helm-other-buffer 'helm-source-advice "*helm advice*"))
@@ -923,7 +923,7 @@ a string, i.e. the `symbol-name\\=' of any existing symbol."
;;;###autoload
(defun helm-timers ()
- "Preconfigured `helm\\=' for timers."
+ "Preconfigured `helm' for timers."
(interactive)
(helm :sources '(helm-source-absolute-time-timers
helm-source-idle-time-timers)
@@ -980,7 +980,7 @@ a string, i.e. the `symbol-name\\=' of any existing symbol."
;;;###autoload
(defun helm-complex-command-history ()
- "Preconfigured `helm\\=' for complex command history."
+ "Preconfigured `helm' for complex command history."
(interactive)
(helm :sources 'helm-source-complex-command-history
:buffer "*helm complex commands*"))
diff --git a/helm-epa.el b/helm-epa.el
index 59488b1767..073b188acd 100644
--- a/helm-epa.el
+++ b/helm-epa.el
@@ -42,13 +42,13 @@
(declare-function helm-read-file-name "helm-mode")
(defvar helm-epa--list-only-secrets nil
- "[INTERNAL] Used to pass MODE argument to `epg-list-keys\\='.")
+ "[INTERNAL] Used to pass MODE argument to `epg-list-keys'.")
(defcustom helm-epa-actions '(("Show key" . epa--show-key)
("encrypt file with key" . helm-epa-encrypt-file)
("Copy keys to kill ring" .
helm-epa-kill-keys-armor)
("Delete keys" . helm-epa-delete-keys))
- "Actions for `helm-epa-list-keys\\='."
+ "Actions for `helm-epa-list-keys'."
:type '(alist :key-type string :value-type symbol)
:group 'helm-misc)
@@ -62,7 +62,7 @@
"Allow building helm sources for GPG keys.")
(defun helm-epa-get-key-list (&optional keys)
- "Build candidate list for `helm-epa-list-keys\\='."
+ "Build candidate list for `helm-epa-list-keys'."
(cl-loop with all-keys = (or keys (epg-list-keys (epg-make-context
epa-protocol)
nil
helm-epa--list-only-secrets))
for key in all-keys
@@ -87,7 +87,7 @@
key)))
(defun helm-epa--select-keys (prompt keys)
- "A helm replacement for `epa--select-keys\\='."
+ "A helm replacement for `epa--select-keys'."
(let ((result (helm :sources (helm-make-source "Epa select keys" 'helm-epa
:candidates (lambda ()
(helm-epa-get-key-list keys)))
@@ -105,7 +105,7 @@
(format "%s: " (replace-regexp-in-string "\\.[\t ]*\\'" "" (car
split))))))
(defun helm-epa--read-signature-type ()
- "A helm replacement for `epa--read-signature-type\\='."
+ "A helm replacement for `epa--read-signature-type'."
(let ((answer (helm-read-answer "Signature type:
(n - Create a normal signature)
(c - Create a cleartext signature)
@@ -241,7 +241,7 @@
;;;###autoload
(defun helm-epa-list-keys ()
"List all gpg keys.
-This is the helm interface for `epa-list-keys\\='."
+This is the helm interface for `epa-list-keys'."
(interactive)
(helm :sources
(helm-make-source "Epg list keys" 'helm-epa
diff --git a/helm-eshell.el b/helm-eshell.el
index 4b94f58351..1b66679665 100644
--- a/helm-eshell.el
+++ b/helm-eshell.el
@@ -49,7 +49,7 @@
(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)
@@ -59,14 +59,14 @@
(set-keymap-parent map helm-map)
(define-key map (kbd "M-p") 'helm-next-line)
map)
- "Keymap for `helm-eshell-history\\='.")
+ "Keymap for `helm-eshell-history'.")
(defvar helm-esh-completion-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map helm-map)
(define-key map (kbd "TAB") 'helm-next-line)
map)
- "Keymap for `helm-esh-pcomplete\\='.")
+ "Keymap for `helm-esh-pcomplete'.")
(defvar helm-eshell--quit-flag nil)
@@ -75,7 +75,7 @@
(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
+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)
@@ -134,7 +134,7 @@ 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)
@@ -259,7 +259,7 @@ 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)
@@ -388,7 +388,7 @@ at point."
(define-key map (kbd "C-c o") 'helm-eshell-prompts-other-window)
(define-key map (kbd "C-c C-o") 'helm-eshell-prompts-other-frame)
map)
- "Keymap for `helm-eshell-prompt-all\\='.")
+ "Keymap for `helm-eshell-prompt-all'.")
(defvar eshell-prompt-regexp)
(defvar eshell-highlight-prompt)
@@ -417,7 +417,7 @@ If BUFFER is nil, use current buffer."
(defun helm-eshell-prompts-list-all ()
"List the prompts of all Eshell buffers.
-See `helm-eshell-prompts-list\\='."
+See `helm-eshell-prompts-list'."
(cl-loop for b in (buffer-list)
append (helm-eshell-prompts-list b)))
@@ -470,7 +470,7 @@ See `helm-eshell-prompts-list\\='."
;;;###autoload
(defun helm-eshell-prompts ()
- "Pre-configured `helm\\=' to browse the prompts of the current Eshell."
+ "Pre-configured `helm' to browse the prompts of the current Eshell."
(interactive)
(if (eq major-mode 'eshell-mode)
(helm :sources
@@ -483,7 +483,7 @@ See `helm-eshell-prompts-list\\='."
;;;###autoload
(defun helm-eshell-prompts-all ()
- "Pre-configured `helm\\=' to browse the prompts of all Eshell sessions."
+ "Pre-configured `helm' to browse the prompts of all Eshell sessions."
(interactive)
(helm :sources
(helm-build-sync-source "All Eshell prompts"
diff --git a/helm-eval.el b/helm-eval.el
index 57f8e86d9f..9d261438a0 100644
--- a/helm-eval.el
+++ b/helm-eval.el
@@ -111,7 +111,7 @@ Should take one arg: the string to display."
(newline) (lisp-indent-line))
(defun helm-eldoc-store-minibuffer ()
- "Store minibuffer buffer name in `helm-eldoc-active-minibuffers-list\\='."
+ "Store minibuffer buffer name in `helm-eldoc-active-minibuffers-list'."
(with-selected-window (minibuffer-window)
(push (current-buffer) helm-eldoc-active-minibuffers-list)))
@@ -166,7 +166,7 @@ Should take one arg: the string to display."
;;;###autoload
(defun helm-eval-expression (arg)
- "Preconfigured `helm\\=' for `helm-source-evaluation-result\\='."
+ "Preconfigured `helm' for `helm-source-evaluation-result'."
(interactive "P")
(helm :sources (helm-build-evaluation-result-source)
:input (when arg (thing-at-point 'sexp))
@@ -177,7 +177,7 @@ Should take one arg: the string to display."
(defvar eldoc-idle-delay)
;;;###autoload
(defun helm-eval-expression-with-eldoc ()
- "Preconfigured `helm\\=' for `helm-source-evaluation-result\\=' with
`eldoc\\=' support."
+ "Preconfigured `helm' for `helm-source-evaluation-result' with `eldoc'
support."
(interactive)
(let ((timer (run-with-idle-timer
eldoc-idle-delay 'repeat
@@ -192,7 +192,7 @@ Should take one arg: the string to display."
;;;###autoload
(defun helm-calcul-expression ()
- "Preconfigured `helm\\=' for `helm-source-calculation-result\\='."
+ "Preconfigured `helm' for `helm-source-calculation-result'."
(interactive)
(helm :sources 'helm-source-calculation-result
:buffer "*helm calcul*"))
diff --git a/helm-external.el b/helm-external.el
index a7e7432e10..c4b7cf4412 100644
--- a/helm-external.el
+++ b/helm-external.el
@@ -32,21 +32,21 @@
(defcustom helm-raise-command nil
"A shell command to jump to a window running specific program.
Need external program wmctrl.
-This will be use with `format\\=', so use something like \"wmctrl -xa %s\"."
+This will be use with `format', so use something like \"wmctrl -xa %s\"."
:type 'string
:group 'helm-external)
(defcustom helm-external-programs-associations nil
"Alist to store externals programs associated with file extension.
This variable overhide setting in .mailcap file.
-E.g.: \\='((\"jpg\" . \"gqview\") (\"pdf\" . \"xpdf\")) "
+E.g.: '\(\(\"jpg\" . \"gqview\"\) (\"pdf\" . \"xpdf\"\)\) "
:type '(alist :key-type string :value-type string)
:group 'helm-external)
(defcustom helm-default-external-file-browser "nautilus"
"Default external file browser for your system.
Directories will be opened externally with it when opening file
-externally in `helm-find-files\\='.
+externally in `helm-find-files'.
Set to nil if you do not have an external file browser or do not
want to use it.
Windows users should set that to \"explorer.exe\"."
@@ -63,9 +63,9 @@ automatically.")
(defun helm-external-commands-list-1 (&optional sort)
"Returns a list of all external commands the user can execute.
-If `helm-external-commands-list\\=' is non-nil it will return its
+If `helm-external-commands-list' is non-nil it will return its
contents. Else it calculates all external commands and sets
-`helm-external-commands-list\\='."
+`helm-external-commands-list'."
(helm-aif helm-external-commands-list
it
(setq helm-external-commands-list
@@ -85,7 +85,7 @@ contents. Else it calculates all external commands and sets
(defun helm-run-or-raise (exe &optional files detached)
"Run asynchronously EXE or jump to the application window.
If EXE is already running just jump to his window if
-`helm-raise-command\\=' is non-nil.
+`helm-raise-command' is non-nil.
When FILES argument is provided run EXE with FILES.
When argument DETACHED is non nil, detach process from Emacs."
(let* ((proc-name (replace-regexp-in-string
@@ -155,7 +155,7 @@ When argument DETACHED is non nil, detach process from
Emacs."
(defun helm-get-default-program-for-file (filename)
"Try to find a default program to open FILENAME.
-Try first in `helm-external-programs-associations\\=' and then in
+Try first in `helm-external-programs-associations' and then in
mailcap file. If nothing found return nil."
(let* ((ext (file-name-extension filename))
(def-prog (assoc-default ext helm-external-programs-associations)))
@@ -167,7 +167,7 @@ mailcap file. If nothing found return nil."
(defun helm-open-file-externally (_file)
"Open FILE with an external program.
Try to guess which program to use with
-`helm-get-default-program-for-file\\='.
+`helm-get-default-program-for-file'.
If not found or a prefix arg is given query the user which tool
to use."
(let* ((files (helm-marked-candidates :with-wildcard t))
@@ -236,10 +236,10 @@ to use."
;;;###autoload
(defun helm-run-external-command ()
- "Preconfigured `helm\\=' to run External PROGRAM asyncronously from Emacs.
-If program is already running try to run `helm-raise-command\\=' if
+ "Preconfigured `helm' to run External PROGRAM asyncronously from Emacs.
+If program is already running try to run `helm-raise-command' if
defined otherwise exit with error. You can set your own list of
-commands with `helm-external-commands-list\\='."
+commands with `helm-external-commands-list'."
(interactive)
(helm :sources `(,(helm-make-source "External Commands history"
'helm-external-commands
:data helm-external-command-history)
diff --git a/helm-files.el b/helm-files.el
index 710eb919a8..4b8757a229 100644
--- a/helm-files.el
+++ b/helm-files.el
@@ -107,29 +107,29 @@
:group 'helm)
(defcustom helm-tramp-verbose 0
- "Just like `tramp-verbose\\=' but specific to Helm.
-When set to 0 don\\='t show tramp messages in Helm.
+ "Just like `tramp-verbose' but specific to Helm.
+When set to 0 don't show tramp messages in Helm.
If you want to have the default tramp messages set it to 3."
:type 'integer
:group 'helm-files)
(defcustom helm-ff-auto-update-initial-value nil
"Auto update when only one candidate directory is matched.
-Default value when starting `helm-find-files\\=' is nil to not
+Default value when starting `helm-find-files' is nil to not
confuse new users.
-For a better experience with `helm-find-files\\=' set this to
+For a better experience with `helm-find-files' set this to
non-nil and use C-<backspace> to toggle it."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-history-max-length 100
- "Number of elements shown in `helm-find-files\\=' history."
+ "Number of elements shown in `helm-find-files' history."
:group 'helm-files
:type 'integer)
(defcustom helm-ff-fuzzy-matching t
- "Enable fuzzy matching for `helm-find-files\\=' when non--nil.
-See `helm-ff--transform-pattern-for-completion\\=' for more info."
+ "Enable fuzzy matching for `helm-find-files' when non--nil.
+See `helm-ff--transform-pattern-for-completion' for more info."
:group 'helm-files
:type 'boolean)
@@ -139,20 +139,20 @@ See `helm-ff--transform-pattern-for-completion\\=' for
more info."
:type 'string)
(defcustom helm-ff-exif-data-program-args "-d"
- "Arguments used for `helm-ff-exif-data-program\\='."
+ "Arguments used for `helm-ff-exif-data-program'."
:group 'helm-files
:type 'string)
(defcustom helm-ff-newfile-prompt-p t
"Whether Prompt or not when creating new file.
-This set `ffap-newfile-prompt\\='."
+This set `ffap-newfile-prompt'."
:type 'boolean
:group 'helm-files)
(defcustom helm-ff-avfs-directory "~/.avfs"
- "The default avfs directory, usually \\='~/.avfs\\='.
+ "The default avfs directory, usually '~/.avfs'.
When this is set you will be able to expand archive filenames
-with `C-j\\=' inside an avfs directory mounted with mountavfs.
+with `C-j' inside an avfs directory mounted with mountavfs.
See <http://sourceforge.net/projects/avf/>."
:type 'string
:group 'helm-files)
@@ -165,22 +165,22 @@ See <http://sourceforge.net/projects/avf/>."
(defcustom helm-ff-printer-list nil
"A list of available printers on your system.
When non-nil let you choose a printer to print file.
-Otherwise when nil the variable `printer-name\\=' will be used.
-On Unix based systems (lpstat command needed) you don\\='t need to
-set this, `helm-ff-find-printers\\=' will find a list of available
+Otherwise when nil the variable `printer-name' will be used.
+On Unix based systems (lpstat command needed) you don't need to
+set this, `helm-ff-find-printers' will find a list of available
printers for you."
:type '(repeat (choice string))
:group 'helm-files)
(defcustom helm-ff-transformer-show-only-basename t
- "Show only basename of candidates in `helm-find-files\\='.
-This can be toggled at anytime from `helm-find-files\\=' with \
+ "Show only basename of candidates in `helm-find-files'.
+This can be toggled at anytime from `helm-find-files' with \
\\<helm-find-files-map>\\[helm-ff-run-toggle-basename]."
:type 'boolean
:group 'helm-files)
(defcustom helm-ff-signal-error-on-dot-files t
- "Signal error when file is `.\\=' or `..\\=' on file deletion when non-nil.
+ "Signal error when file is `.' or `..' on file deletion when non-nil.
Default is non-nil.
WARNING: Setting this to nil is unsafe and can cause deletion of
a whole tree."
@@ -188,7 +188,7 @@ a whole tree."
:type 'boolean)
(defcustom helm-ff-search-library-in-sexp nil
- "Search for library in `require\\=' and `declare-function\\=' sexp."
+ "Search for library in `require' and `declare-function' sexp."
:group 'helm-files
:type 'boolean)
@@ -198,49 +198,49 @@ a whole tree."
:type 'integer)
(defcustom helm-ff-file-name-history-use-recentf nil
- "Use `recentf-list\\=' instead of `file-name-history\\=' in
`helm-find-files\\='."
+ "Use `recentf-list' instead of `file-name-history' in `helm-find-files'."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-skip-boring-files nil
"Non-nil to skip boring files.
-I.e. the files matching regexps in `helm-boring-file-regexp-list\\='.
-This takes effect in `helm-find-files\\=' and file completion used by
-`helm-mode\\=' i.e. `helm-read-file-name\\='.
-Note that when non-nil this will slow down slightly `helm-find-files\\='."
+I.e. the files matching regexps in `helm-boring-file-regexp-list'.
+This takes effect in `helm-find-files' and file completion used by
+`helm-mode' i.e. `helm-read-file-name'.
+Note that when non-nil this will slow down slightly `helm-find-files'."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-skip-git-ignored-files nil
"Non-nil to skip git ignored files.
-This take effect only in `helm-find-files\\='.
+This take effect only in `helm-find-files'.
Check is not done on remote files.
Note that when non-nil this will slow down slightly
-`helm-find-files\\='."
+`helm-find-files'."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-candidate-number-limit 5000
- "The `helm-candidate-number-limit\\=' for `helm-find-files\\=' and friends.
+ "The `helm-candidate-number-limit' for `helm-find-files' and friends.
Note that when going one level up with
-`\\<helm-find-files-map>\\[helm-find-files-up-one-level]\\=' the
+`\\<helm-find-files-map>\\[helm-find-files-up-one-level]' the
length of directory will be used instead if it is higher than
this value. This is to avoid failing to preselect the previous
directory/file if this one is situated lower than
-`helm-ff-candidate-number-limit\\=' num candidate."
+`helm-ff-candidate-number-limit' num candidate."
:group 'helm-files
:type 'integer)
(defcustom helm-ff-up-one-level-preselect t
"Always preselect previous directory when going one level up.
-When non-nil `candidate-number-limit\\=' source value is modified
+When non-nil `candidate-number-limit' source value is modified
dynamically when going one level up if the position of previous
candidate in its directory is > to
-`helm-ff-candidate-number-limit\\='.
+`helm-ff-candidate-number-limit'.
It can be helpful to disable this and reduce
-`helm-ff-candidate-number-limit\\=' if you often navigate across
+`helm-ff-candidate-number-limit' if you often navigate across
very large directories."
:group 'helm-files
:type 'boolean)
@@ -248,61 +248,61 @@ very large directories."
(defcustom helm-files-save-history-extra-sources
'("Find" "Locate" "Recentf"
"Files from Current Directory" "File Cache")
- "Extras source that save candidate to `file-name-history\\='."
+ "Extras source that save candidate to `file-name-history'."
:group 'helm-files
:type '(repeat (choice string)))
(defcustom helm-find-files-before-init-hook nil
- "Hook that run before initialization of `helm-find-files\\='."
+ "Hook that run before initialization of `helm-find-files'."
:group 'helm-files
:type 'hook)
(defcustom helm-find-files-after-init-hook nil
- "Hook that run after initialization of `helm-find-files\\='."
+ "Hook that run after initialization of `helm-find-files'."
:group 'helm-files
:type 'hook)
(defcustom helm-find-files-bookmark-prefix nil
- "bookmark name prefix of `helm-find-files\\=' sessions."
+ "bookmark name prefix of `helm-find-files' sessions."
:group 'helm-files
:type 'string)
(defcustom helm-ff-guess-ffap-filenames nil
- "Use ffap to guess local filenames at point in `helm-find-files\\='.
-This doesn\\='t disable url or mail at point, see
-`helm-ff-guess-ffap-urls\\=' for this."
+ "Use ffap to guess local filenames at point in `helm-find-files'.
+This doesn't disable url or mail at point, see
+`helm-ff-guess-ffap-urls' for this."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-guess-ffap-urls t
- "Use ffap to guess local urls at point in `helm-find-files\\='.
-This doesn\\='t disable guessing filenames at point, see
-`helm-ff-guess-ffap-filenames\\=' for this.
-See also `ffap-url-unwrap-remote\\=' that may override this
+ "Use ffap to guess local urls at point in `helm-find-files'.
+This doesn't disable guessing filenames at point, see
+`helm-ff-guess-ffap-filenames' for this.
+See also `ffap-url-unwrap-remote' that may override this
variable."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-no-preselect nil
- "When non-nil `helm-find-files\\=' starts at root of current directory."
+ "When non-nil `helm-find-files' starts at root of current directory."
:group 'helm-files
:type 'boolean)
(defcustom helm-ff-allow-non-existing-file-at-point nil
- "Use non existing file-at-point as initial input in `helm-find-files\\='."
+ "Use non existing file-at-point as initial input in `helm-find-files'."
:group 'helm-files
:type 'boolean)
(defcustom helm-find-files-ignore-thing-at-point nil
- "Use only `default-directory\\=' as default input in `helm-find-files\\='.
-I.e. text under cursor in `current-buffer\\=' is ignored.
+ "Use only `default-directory' as default input in `helm-find-files'.
+I.e. text under cursor in `current-buffer' is ignored.
Note that when non-nil you will be unable to complete filename at
-point in `current-buffer\\='."
+point in `current-buffer'."
:group 'helm-files
:type 'boolean)
(defcustom helm-substitute-in-filename-stay-on-remote nil
- "Don\\='t switch back to local filesystem when expanding pattern with / or
~/."
+ "Don't switch back to local filesystem when expanding pattern with / or ~/."
:group 'helm-files
:type 'boolean)
@@ -314,7 +314,7 @@ point in `current-buffer\\='."
(defcustom helm-mounted-network-directories nil
"A list of directories used for mounting remotes filesystem.
-When nil `helm-file-on-mounted-network-p\\=' always return nil
+When nil `helm-file-on-mounted-network-p' always return nil
otherwise check if a file is in one of these directories.
Remote filesystem are generally mounted with sshfs."
@@ -337,9 +337,9 @@ A function that takes a directory name as only arg."
(defcustom helm-ff-kill-or-find-buffer-fname-fn
#'helm-ff-kill-or-find-buffer-fname
- "Default function used to expand non-directory filenames in
`helm-find-files\\='.
+ "Default function used to expand non-directory filenames in
`helm-find-files'.
-This variable will take effect only in `helm-find-files\\='. It
+This variable will take effect only in `helm-find-files'. It
affects the behavior of persistent-action on filenames and
non-existing filenames.
@@ -351,7 +351,7 @@ navigating, show quickly the buffer of file to see its
contents
briefly before killing it and continue navigating.
However some users may not want this, so to disable this behaviour
-just set this to `ignore\\=' function.
+just set this to `ignore' function.
Of course you can also write your own function to do something
else."
@@ -360,12 +360,12 @@ else."
(defcustom helm-modes-using-escaped-strings
'(eshell-mode shell-mode term-mode)
- "Modes that requires string\\='s insertion to be escaped."
+ "Modes that requires string's insertion to be escaped."
:group 'helm-files
:type '(repeat symbol))
(defcustom helm-ff-allow-recursive-deletes nil
- "When \\='always don\\='t prompt for recursive deletion of directories.
+ "When 'always don't prompt for recursive deletion of directories.
When nil, will ask for recursive deletion.
Note that when deleting multiple directories you can answer !
when prompted to avoid being asked for next directories, so it
@@ -386,8 +386,8 @@ recursive deletion of directories, IOW non-empty
directories will
be deleted with no warnings in background!!!
It is the function that will be used when using
-`\\<helm-find-files-map>\\[helm-ff-run-delete-file]\\=' from
-`helm-find-files\\='."
+`\\<helm-find-files-map>\\[helm-ff-run-delete-file]' from
+`helm-find-files'."
:group 'helm-files
:type '(choice (function :tag "Delete files synchronously."
helm-delete-marked-files)
@@ -397,18 +397,18 @@ It is the function that will be used when using
(defcustom helm-trash-remote-files nil
"Allow trashing remote files when non-nil.
-Trashing remote files with tramp doesn\\='t work out of the box
-unless the \\='trash-cli\\=' package is installed. This is why trashing
+Trashing remote files with tramp doesn't work out of the box
+unless the 'trash-cli' package is installed. This is why trashing
remote files from Helm is disabled by default.
-Tramp is using external \\='trash\\=' command in its `delete-file\\=' and
-`delete-directory\\=' handlers when using
-`delete-by-moving-to-trash\\=', which is documented nowhere in
+Tramp is using external 'trash' command in its `delete-file' and
+`delete-directory' handlers when using
+`delete-by-moving-to-trash', which is documented nowhere in
Emacs.
-If you want to enable this you will have to install the \\='trash\\='
+If you want to enable this you will have to install the 'trash'
command on remote (and/or locally if you want to trash as root).
-On Ubuntu-based distributions it is \\='trash-cli\\='."
+On Ubuntu-based distributions it is 'trash-cli'."
:group 'helm-files
:type 'boolean)
@@ -418,23 +418,23 @@ On Ubuntu-based distributions it is \\='trash-cli\\='."
(berkeley-unix #'helm-list-dir-lisp)
(windows-nt #'helm-list-dir-lisp)
(t #'helm-list-dir-lisp))
- "The function used in `helm-find-files\\=' to list remote directories.
+ "The function used in `helm-find-files' to list remote directories.
Actually Helm provides two functions to do this:
-`helm-list-dir-lisp\\=' and `helm-list-dir-external\\='.
+`helm-list-dir-lisp' and `helm-list-dir-external'.
-Using `helm-list-dir-external\\=' will provide a similar display to
+Using `helm-list-dir-external' will provide a similar display to
what is provided with local files i.e. colorized symlinks,
-executables files etc., whereas using `helm-list-dir-lisp\\=' will
+executables files etc., whereas using `helm-list-dir-lisp' will
allow colorizing only directories but it is more portable.
-NOTE: `helm-list-dir-external\\=' needs ls and awk as dependencies.
+NOTE: `helm-list-dir-external' needs ls and awk as dependencies.
Also the ls version installed on the remote side should support
the same arguments as the GNU/ls version, which are -A -1 -F -b
and -Q. So even if you are using a GNU/ls version locally and you
want to connect e.g. on a Freebsd server, you may have failures
due to the incompatible ls version installed on remote server. In
-such case use `helm-list-dir-lisp\\=' which works everywhere but is
+such case use `helm-list-dir-lisp' which works everywhere but is
slower and less featured (only directories colorized)."
:type 'function
:group 'helm-files)
@@ -443,7 +443,7 @@ slower and less featured (only directories colorized)."
"Sort method to use when initially listing a directory.
It is better to keep this nil globally and turn it on only when needed
-otherwise it may be slightly slower specially with `ext\\=' method which
+otherwise it may be slightly slower specially with `ext' method which
BTW is not provided on remote files (helm will fallback on nil in such
case).
Note that this have no effect as soon as you start narrowing directory
@@ -457,10 +457,10 @@ i.e. filtering filenames inside directory."
(defcustom helm-ff-rotate-image-program "exiftran"
"External program used to rotate images.
-When nil and `helm-ff-display-image-native\\=' is enabled, fallback to
-`image-rotate\\=' without modification of exif data i.e. rotation is not
+When nil and `helm-ff-display-image-native' is enabled, fallback to
+`image-rotate' without modification of exif data i.e. rotation is not
persistent otherwise an error is returned when not using
-`helm-ff-display-image-native\\=' i.e. using image-dired."
+`helm-ff-display-image-native' i.e. using image-dired."
:group 'helm-files
:type '(choice
(const :tag "Mogrify" "mogrify")
@@ -468,16 +468,16 @@ persistent otherwise an error is returned when not using
(const :tag "Jpegtran" "jpegtran")))
(defcustom helm-ff-rotate-image-switch '("-i")
- "Options used with `helm-ff-rotate-image-program\\='.
+ "Options used with `helm-ff-rotate-image-program'.
If you are using Mogrify or Jpegtran mandatory option is
\"-rotate\", with Exiftran mandatory option is \"-i\"."
:group 'helm-files
:type '(repeat string))
(defcustom helm-ff-preferred-shell-mode 'eshell-mode
- "Shell to use to switch to a shell buffer from `helm-find-files\\='.
-Possible values are `shell-mode\\=', `eshell-mode\\=' and `term-mode\\='.
-This affects `\\<helm-find-files-map>\\[helm-ff-run-switch-to-shell]\\='
keybinding."
+ "Shell to use to switch to a shell buffer from `helm-find-files'.
+Possible values are `shell-mode', `eshell-mode' and `term-mode'.
+This affects `\\<helm-find-files-map>\\[helm-ff-run-switch-to-shell]'
keybinding."
:group 'helm-files
:type '(choice
(const :tag "Use Eshell" eshell-mode)
@@ -485,10 +485,10 @@ This affects
`\\<helm-find-files-map>\\[helm-ff-run-switch-to-shell]\\=' keybind
(const :tag "Use Shell" term-mode)))
(defcustom helm-rsync-no-mode-line-update nil
- "When non nil don\\='t update mode-line when rsync is running.
+ "When non nil don't update mode-line when rsync is running.
This is useful if you display the progress bar somewhere else,
e.g. with minibuffer-line in minibuffer, in this case updating
-mode-line may create flickering in other frame\\='s mode-line."
+mode-line may create flickering in other frame's mode-line."
:type 'boolean
:group 'helm-files)
@@ -507,9 +507,9 @@ currently transfered in an help-echo in mode-line, if you
use
(defcustom helm-trash-default-directory nil
"The default trash directory.
-You probably don\\='t need to set this when using a Linux system using
+You probably don't need to set this when using a Linux system using
standard settings.
-Should be the directory file name i.e. don\\='t add final slash.
+Should be the directory file name i.e. don't add final slash.
When nil helm will compute a default value according to freedesktop
specs.
It is generally \"~/.local/share/Trash\"."
@@ -528,115 +528,115 @@ It is generally \"~/.local/share/Trash\"."
(defface helm-ff-prefix
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:background "yellow" :foreground "black"))
- "Face used to prefix new file or url paths in `helm-find-files\\='."
+ "Face used to prefix new file or url paths in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-executable
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "green"))
- "Face used for executable files in `helm-find-files\\='."
+ "Face used for executable files in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-suid
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:background "red" :foreground "white"))
- "Face used for suid files in `helm-find-files\\='."
+ "Face used for suid files in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-directory
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "DarkRed" :background "LightGray"))
- "Face used for directories in `helm-find-files\\='."
+ "Face used for directories in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-dotted-directory
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "black" :background "DimGray"))
- "Face used for dotted directories in `helm-find-files\\='."
+ "Face used for dotted directories in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-dotted-symlink-directory
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "DarkOrange" :background "DimGray"))
- "Face used for dotted symlinked directories in `helm-find-files\\='."
+ "Face used for dotted symlinked directories in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-symlink
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:inherit font-lock-comment-face))
- "Face used for symlinks in `helm-find-files\\='."
+ "Face used for symlinks in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-invalid-symlink
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "black" :background "red"))
- "Face used for invalid symlinks in `helm-find-files\\='."
+ "Face used for invalid symlinks in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-denied
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "red" :background "black"))
- "Face used for non accessible files in `helm-find-files\\='."
+ "Face used for non accessible files in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-file
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:inherit font-lock-builtin-face))
- "Face used for file names in `helm-find-files\\='."
+ "Face used for file names in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-nofile
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:inherit helm-ff-file))
- "Face used for file names in `helm-find-files\\='."
+ "Face used for file names in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-truename
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:inherit font-lock-string-face))
- "Face used for symlink truenames in `helm-find-files\\='."
+ "Face used for symlink truenames in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-dirs
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:inherit font-lock-function-name-face))
- "Face used for file names in recursive dirs completion in
`helm-find-files\\='."
+ "Face used for file names in recursive dirs completion in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-socket
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "DeepPink"))
- "Face used for socket files in `helm-find-files\\='."
+ "Face used for socket files in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-pipe
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "yellow" :background "black"))
- "Face used for named pipes and character device files in
`helm-find-files\\='."
+ "Face used for named pipes and character device files in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-file-extension
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "magenta"))
- "Face used for file extensions in `helm-find-files\\='."
+ "Face used for file extensions in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-ff-backup-file
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "DimGray"))
- "Face used for backup files in `helm-find-files\\='."
+ "Face used for backup files in `helm-find-files'."
:group 'helm-files-faces)
(defface helm-history-deleted
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:inherit helm-ff-invalid-symlink))
- "Face used for deleted files in `file-name-history\\='."
+ "Face used for deleted files in `file-name-history'."
:group 'helm-files-faces)
(defface helm-history-remote
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "Indianred1"))
- "Face used for remote files in `file-name-history\\='."
+ "Face used for remote files in `file-name-history'."
:group 'helm-files-faces)
(defface helm-delete-async-message
@@ -735,7 +735,7 @@ It is generally \"~/.local/share/Trash\"."
(when (fboundp 'tab-bar-mode)
(define-key map (kbd "C-c C-t") 'helm-ff-find-file-other-tab))
map)
- "Keymap for `helm-find-files\\='.")
+ "Keymap for `helm-find-files'.")
(defvar helm-read-file-map
(let ((map (make-sparse-keymap)))
@@ -756,11 +756,11 @@ It is generally \"~/.local/share/Trash\"."
([C-c DEL] .
helm-ff-run-toggle-auto-update))
nil 'helm-ff-delete-char-backward--exit-fn)
map)
- "Keymap for `helm-read-file-name\\='.")
+ "Keymap for `helm-read-file-name'.")
(defcustom helm-ff-lynx-style-map t
- "Use arrow keys to navigate with `helm-find-files\\='.
-Note that if you define this variable with `setq\\=' your change
+ "Use arrow keys to navigate with `helm-find-files'.
+Note that if you define this variable with `setq' your change
will have no effect, use customize instead."
:group 'helm-files
:type 'boolean
@@ -788,14 +788,14 @@ When nil always delete char backward."
:type 'boolean)
(defcustom helm-ff-display-image-native t
- "Use native `image-mode\\=' when non nil.
+ "Use native `image-mode' when non nil.
-You should use this only with Emacs>= 27 and `image-auto-resize\\='
+You should use this only with Emacs>= 27 and `image-auto-resize'
enabled to have images resized properly. When this is enabled,
you have new commands to zoom in/out images. See
-`image-transform-resize\\=' and `image-auto-resize\\='. Otherwise,
-when nil `image-dired\\=' is used, using imagemagick as backend.
-NOTE: On Emacs-29 `image-dired\\=' is no more using external program
+`image-transform-resize' and `image-auto-resize'. Otherwise,
+when nil `image-dired' is used, using imagemagick as backend.
+NOTE: On Emacs-29 `image-dired' is no more using external program
image-magick to display image, so this is used inconditionally even
when value is nil."
:group 'helm-files
@@ -823,15 +823,15 @@ display part of the candidate regexp quoted.")
(defvar helm-find-files-doc-header "
(\\<helm-find-files-map>\\[helm-find-files-up-one-level]: Go up one level)"
"*The doc that is inserted in the Name header of a find-files or dired
source.")
(defvar helm-ff-auto-update-flag nil
- "Internal, flag to turn on/off auto-update in `helm-find-files\\='.
-Don\\='t set it directly, use instead `helm-ff-auto-update-initial-value\\='.")
+ "Internal, flag to turn on/off auto-update in `helm-find-files'.
+Don't set it directly, use instead `helm-ff-auto-update-initial-value'.")
(defvar helm-ff-last-expanded nil
"Store last expanded directory or file.")
(defvar helm-ff-default-directory nil)
(defvar helm-ff-history nil)
(defvar helm-ff-url-regexp
"\\`\\(news\\(post\\)?:\\|nntp:\\|mailto:\\|file:\\|\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\):/?/?\\).*"
- "Same as `ffap-url-regexp\\=' but match earlier possible url.")
+ "Same as `ffap-url-regexp' but match earlier possible url.")
;; helm-tramp-file-name-regexp is based on old version of
;; tramp-file-name-regexp i.e. "\\`/\\([^[/:]+\\|[^/]+]\\):" but it
;; seems it is wrong and a simpler regexp is enough, let's try it and
@@ -848,11 +848,11 @@ Don\\='t set it directly, use instead
`helm-ff-auto-update-initial-value\\='.")
(defvar helm-ff--directory-files-length (make-hash-table :test 'equal)
"Used to count number of candidates in directory.
candidate-number-limit is set to this value if this value is bigger
-than `helm-candidate-number-limit\\='.")
+than `helm-candidate-number-limit'.")
(defvar helm-ff--list-directory-cache (make-hash-table :test 'equal)
- "Cache for `helm-find-files\\=' candidates.")
+ "Cache for `helm-find-files' candidates.")
(defvar helm-ff--file-notify-watchers (make-hash-table :test 'equal)
- "File-notify watchers for `helm-find-files\\=' are stored here.")
+ "File-notify watchers for `helm-find-files' are stored here.")
(defvar helm-ff-history-buffer-name "*helm-find-files history*")
(defvar helm-rsync-command-history nil)
(defvar helm-rsync--last-progress-bar-alist nil
@@ -931,7 +931,7 @@ This is used only as a let binding.")
'find-file-other-tab
"Print File `C-c p, C-u to refresh'" 'helm-ff-print
"Locate `C-x C-f, C-u to specify locate db'" 'helm-ff-locate)
- "Actions for `helm-find-files\\='."
+ "Actions for `helm-find-files'."
:group 'helm-files
:type '(alist :key-type string :value-type function))
@@ -986,14 +986,14 @@ Should not be used among other sources.")
;; Bookmark handlers.
;;
(defun helm-ff-make-bookmark-record ()
- "The `bookmark-make-record-function\\=' for `helm-find-files\\='."
+ "The `bookmark-make-record-function' for `helm-find-files'."
(with-helm-buffer
`((filename . ,helm-ff-default-directory)
(presel . ,(helm-get-selection))
(handler . helm-ff-bookmark-jump))))
(defun helm-ff-bookmark-jump (bookmark)
- "bookmark handler for `helm-find-files\\='."
+ "bookmark handler for `helm-find-files'."
(let ((fname (bookmark-prop-get bookmark 'filename))
(presel (bookmark-prop-get bookmark 'presel)))
;; Force tramp connection with `file-directory-p' before lauching
@@ -1008,7 +1008,7 @@ Should not be used among other sources.")
(regexp-quote presel)))))))
(defun helm-ff-bookmark-set ()
- "Record `helm-find-files\\=' session in bookmarks."
+ "Record `helm-find-files' session in bookmarks."
(interactive)
(with-helm-alive-p
(with-helm-buffer
@@ -1023,8 +1023,8 @@ Should not be used among other sources.")
Define the directory where you want to start navigating for the
target directory when copying, renaming, etc.. You can use the
-`default-directory\\=' of `next-window\\=', the visited directory, the
-current `default-directory\\=' or have completion on all the
+`default-directory' of `next-window', the visited directory, the
+current `default-directory' or have completion on all the
directories belonging to each visible windows."
:group 'helm-files
:type '(radio :tag "Define default target directory for file actions."
@@ -1038,7 +1038,7 @@ directories belonging to each visible windows."
nil)))
(defun helm-dwim-target-directory ()
- "Try to return a suitable directory according to `helm-dwim-target\\='."
+ "Try to return a suitable directory according to `helm-dwim-target'."
(with-selected-window (get-buffer-window helm-current-buffer)
(let ((wins (remove (get-buffer-window helm-marked-buffer-name)
(window-list))))
@@ -1093,8 +1093,8 @@ directories belonging to each visible windows."
collect k)))
(defun helm-find-files-do-action (action &optional target)
- "Generic function for creating actions from `helm-source-find-files\\='.
-ACTION can be `rsync\\=' or any action supported by `helm-dired-action\\='."
+ "Generic function for creating actions from `helm-source-find-files'.
+ACTION can be `rsync' or any action supported by `helm-dired-action'."
(require 'dired-async)
(when (eq action 'rsync)
(cl-assert (executable-find "rsync") nil "No command named rsync"))
@@ -1212,7 +1212,7 @@ ACTION can be `rsync\\=' or any action supported by
`helm-dired-action\\='."
"Send FILES to DEST using Rsync with SWITCHES as arguments.
DEST must be a directory. SWITCHES when unspecified default to
-`helm-rsync-switches\\='."
+`helm-rsync-switches'."
(cl-assert (file-directory-p dest) t)
(setq files (cl-loop for f in files
collect (helm-rsync-remote2rsync f))
@@ -1260,7 +1260,7 @@ DEST must be a directory. SWITCHES when unspecified
default to
(set-process-filter proc #'helm-rsync-process-filter)))
(defun helm-rsync-process-filter (proc output)
- "Filter process function used by `helm-rsync-copy-files\\='."
+ "Filter process function used by `helm-rsync-copy-files'."
(let ((inhibit-read-only t)
fname progbar)
(with-current-buffer (process-buffer proc)
@@ -1330,34 +1330,34 @@ one process."
helm-rsync-progress-str-alist)))
(defun helm-find-files-rsync (_candidate)
- "Rsync files from `helm-find-files\\='."
+ "Rsync files from `helm-find-files'."
(helm-find-files-do-action 'rsync))
(defun helm-find-files-copy (_candidate)
- "Copy files from `helm-find-files\\='."
+ "Copy files from `helm-find-files'."
(helm-find-files-do-action 'copy))
(defun helm-find-files-backup (_candidate)
- "Backup files from `helm-find-files\\='.
+ "Backup files from `helm-find-files'.
This reproduce the behavior of \"cp --backup=numbered from to\"."
(cl-assert (and (fboundp 'dired-async-mode) dired-async-mode) nil
"Backup only available when `dired-async-mode' is enabled")
(helm-find-files-do-action 'backup))
(defun helm-find-files-rename (_candidate)
- "Rename files from `helm-find-files\\='."
+ "Rename files from `helm-find-files'."
(helm-find-files-do-action 'rename))
(defun helm-find-files-symlink (_candidate)
- "Symlink files from `helm-find-files\\='."
+ "Symlink files from `helm-find-files'."
(helm-find-files-do-action 'symlink))
(defun helm-find-files-relsymlink (_candidate)
- "Relsymlink files from `helm-find-files\\='."
+ "Relsymlink files from `helm-find-files'."
(helm-find-files-do-action 'relsymlink))
(defun helm-find-files-hardlink (_candidate)
- "Hardlink files from `helm-find-files\\='."
+ "Hardlink files from `helm-find-files'."
(helm-find-files-do-action 'hardlink))
(defun helm-find-files-other-window (_candidate)
@@ -1369,7 +1369,7 @@ windows layout."
(helm-window-show-buffers buffers t)))
(defun helm-find-files-byte-compile (_candidate)
- "Byte compile elisp files from `helm-find-files\\='."
+ "Byte compile elisp files from `helm-find-files'."
(let ((files (helm-marked-candidates :with-wildcard t))
(parg helm-current-prefix-arg))
(cl-loop for fname in files
@@ -1382,13 +1382,13 @@ windows layout."
(when parg (load fname)))))))
(defun helm-find-files-load-files (_candidate)
- "Load elisp files from `helm-find-files\\='."
+ "Load elisp files from `helm-find-files'."
(let ((files (helm-marked-candidates :with-wildcard t)))
(cl-loop for fname in files
do (load fname))))
(defun helm-find-files-ediff-files-1 (candidate &optional merge)
- "Generic function to ediff/merge files in `helm-find-files\\='."
+ "Generic function to ediff/merge files in `helm-find-files'."
(let* ((helm-dwim-target 'next-window)
(bname (helm-basename candidate))
(marked (helm-marked-candidates :with-wildcard t))
@@ -1415,12 +1415,12 @@ windows layout."
(helm-find-files-ediff-files-1 candidate 'merge))
(defun helm-find-files-grep (_candidate)
- "Default action to grep files from `helm-find-files\\='."
+ "Default action to grep files from `helm-find-files'."
(helm-do-grep-1 (helm-marked-candidates :with-wildcard t)
helm-current-prefix-arg))
(defun helm-ff-git-grep (_candidate)
- "Default action to git-grep `helm-ff-default-directory\\='."
+ "Default action to git-grep `helm-ff-default-directory'."
(helm-grep-git-1 helm-ff-default-directory helm-current-prefix-arg))
(defun helm-find-files-ag (_candidate)
@@ -1428,11 +1428,11 @@ windows layout."
helm-current-prefix-arg))
(defun helm-ff-zgrep (_candidate)
- "Default action to zgrep files from `helm-find-files\\='."
+ "Default action to zgrep files from `helm-find-files'."
(helm-ff-zgrep-1 (helm-marked-candidates :with-wildcard t)
helm-current-prefix-arg))
(defun helm-ff-pdfgrep (_candidate)
- "Default action to pdfgrep files from `helm-find-files\\='."
+ "Default action to pdfgrep files from `helm-find-files'."
(let* ((recurse nil)
(cands (cl-loop for file in (helm-marked-candidates :with-wildcard t)
for dir = (file-directory-p file)
@@ -1445,7 +1445,7 @@ windows layout."
(helm-do-pdfgrep-1 cands recurse))))
(defun helm-ff-etags-select (candidate)
- "Default action to jump to etags from `helm-find-files\\='."
+ "Default action to jump to etags from `helm-find-files'."
(when (get-buffer helm-action-buffer)
(kill-buffer helm-action-buffer))
(let* ((source-name (assoc-default 'name (helm-get-current-source)))
@@ -1460,7 +1460,7 @@ windows layout."
(defvar helm-eshell-command-on-file-input-history nil)
(defvar helm-eshell-command-on-file-history nil)
(cl-defun helm-find-files-eshell-command-on-file-1 (&optional map)
- "Run `eshell-command\\=' on CANDIDATE or marked candidates.
+ "Run `eshell-command' on CANDIDATE or marked candidates.
This is done possibly with an Eshell alias. If no alias found,
you can type in an Eshell command.
@@ -1474,8 +1474,8 @@ Where \"*.el\" is the CANDIDATE.
It is possible to do eshell-command command <CANDIDATE> <some
more args> like this: \"command %s some more args\".
-If MAP is given run `eshell-command\\=' on all marked files at once,
-Otherwise, run `eshell-command\\=' on each marked files.
+If MAP is given run `eshell-command' on all marked files at once,
+Otherwise, run `eshell-command' on each marked files.
In other terms, with a prefix arg do on the three marked files
\"foo\" \"bar\" \"baz\":
@@ -1488,8 +1488,8 @@ otherwise do
\"eshell-command command baz\"
Note:
-You have to setup some aliases in Eshell with the `alias\\=' command
-or by editing yourself the file `eshell-aliases-file\\=' to make
+You have to setup some aliases in Eshell with the `alias' command
+or by editing yourself the file `eshell-aliases-file' to make
this working."
(require 'helm-adaptive)
(require 'em-alias) (eshell-read-aliases-list)
@@ -1669,8 +1669,8 @@ this working."
(or (and (processp val) delim) val)))))
(defun helm-find-files-eshell-command-on-file (_candidate)
- "Run `eshell-command\\=' on CANDIDATE or marked candidates.
-See `helm-find-files-eshell-command-on-file-1\\=' for more info."
+ "Run `eshell-command' on CANDIDATE or marked candidates.
+See `helm-find-files-eshell-command-on-file-1' for more info."
(helm-find-files-eshell-command-on-file-1 helm-current-prefix-arg))
(defun helm-ff--shell-interactive-buffer-p (buffer &optional mode)
@@ -1686,14 +1686,14 @@ See `helm-find-files-eshell-command-on-file-1\\=' for
more info."
(null (eql (point) (point-min))))))))
(defun helm-ff-switch-to-shell (_candidate)
- "Switch to a shell buffer and cd to `helm-ff-default-directory\\='.
-Set your preferred shell mode in `helm-ff-preferred-shell-mode\\='.
+ "Switch to a shell buffer and cd to `helm-ff-default-directory'.
+Set your preferred shell mode in `helm-ff-preferred-shell-mode'.
With a numeric prefix arg switch to numbered shell buffer, if no
prefix arg provided and more than one shell buffer exists, provide
completions on those buffers. If only one shell buffer exists,
switch to this one, if no shell buffer exists or if the numeric
-prefix arg shell buffer doesn\\='t exists, create it and switch to it."
+prefix arg shell buffer doesn't exists, create it and switch to it."
;; Reproduce the Emacs-25 behavior to be able to edit and send
;; command in term buffer.
(let (term-char-mode-buffer-read-only ; Emacs-25 behavior.
@@ -1752,7 +1752,7 @@ prefix arg shell buffer doesn\\='t exists, create it and
switch to it."
(if (eq major-mode 'eshell-mode) cd-eshell cd-shell)))))
(defun helm-ff-shell-alive-p (mode)
- "Returns non nil when a process is running inside `shell-mode\\=' buffer."
+ "Returns non nil when a process is running inside `shell-mode' buffer."
(cl-ecase mode
(shell-mode
(save-excursion
@@ -1896,8 +1896,8 @@ prefix arg shell buffer doesn\\='t exists, create it and
switch to it."
helm-ff--show-files-only nil)))
(defun helm-ff-serial-rename-action (method)
- "Rename all marked files in `helm-ff-default-directory\\=' with METHOD.
-See `helm-ff-serial-rename-1\\='."
+ "Rename all marked files in `helm-ff-default-directory' with METHOD.
+See `helm-ff-serial-rename-1'."
(let* ((helm--reading-passwd-or-string t)
(cands (helm-marked-candidates :with-wildcard t))
(def-name (car cands))
@@ -1989,31 +1989,31 @@ Default METHOD is rename."
(delete-directory tmp-dir t))))
(defun helm-ff-serial-rename (_candidate)
- "Serial rename all marked files to `helm-ff-default-directory\\='.
+ "Serial rename all marked files to `helm-ff-default-directory'.
Rename only file of current directory, and symlink files coming from
other directories.
-See `helm-ff-serial-rename-1\\='."
+See `helm-ff-serial-rename-1'."
(helm-ff-serial-rename-action 'rename))
(defun helm-ff-serial-rename-by-symlink (_candidate)
- "Serial rename all marked files to `helm-ff-default-directory\\='.
+ "Serial rename all marked files to `helm-ff-default-directory'.
Rename only file of current directory, and symlink files coming
from other directories.
-See `helm-ff-serial-rename-1\\='."
+See `helm-ff-serial-rename-1'."
(helm-ff-serial-rename-action 'symlink))
(defun helm-ff-serial-rename-by-copying (_candidate)
- "Serial rename all marked files to `helm-ff-default-directory\\='.
+ "Serial rename all marked files to `helm-ff-default-directory'.
Rename only file of current directory, and copy files coming from
other directories.
-See `helm-ff-serial-rename-1\\='."
+See `helm-ff-serial-rename-1'."
(helm-ff-serial-rename-action 'copy))
(defvar helm-ff-query-replace-fnames-history-from nil)
(defvar helm-ff-query-replace-fnames-history-to nil)
(defun helm-ff-query-replace-on-filenames (candidates)
"Query replace on filenames of CANDIDATES.
-This doesn\\='t replace inside the files, only modify filenames."
+This doesn't replace inside the files, only modify filenames."
(with-helm-display-marked-candidates
helm-marked-buffer-name
(mapcar 'helm-basename candidates)
@@ -2243,10 +2243,10 @@ at end of pattern using \\<helm-map>\\[backward-char]
and
(defvar helm-ff--RET-disabled nil)
(defun helm-ff-RET-1 (&optional must-match)
- "Used for RET action in `helm-find-files\\='.
-See `helm-ff-RET\\=' for details.
+ "Used for RET action in `helm-find-files'.
+See `helm-ff-RET' for details.
If MUST-MATCH is specified exit with
-`helm-confirm-and-exit-minibuffer\\=' which handle must-match mechanism."
+`helm-confirm-and-exit-minibuffer' which handle must-match mechanism."
(let ((sel (helm-get-selection))
;; Ensure `file-directory-p' works on remote files.
non-essential)
@@ -2268,9 +2268,9 @@ If MUST-MATCH is specified exit with
(helm-maybe-exit-minibuffer)))))
(defun helm-ff-RET ()
- "Default action for RET in `helm-find-files\\='.
+ "Default action for RET in `helm-find-files'.
-Behave differently depending on `helm-selection\\=':
+Behave differently depending on `helm-selection':
- candidate basename is \".\" => open it in dired.
- candidate is a directory => expand it.
@@ -2280,7 +2280,7 @@ Behave differently depending on `helm-selection\\=':
(put 'helm-ff-RET 'helm-only t)
(defun helm-ff-TAB-1 (&optional force-menu)
- "Used for TAB action in `helm-find-files\\='."
+ "Used for TAB action in `helm-find-files'."
(let ((sel (helm-get-selection)))
(if (and (null force-menu)
(file-directory-p sel)
@@ -2289,9 +2289,9 @@ Behave differently depending on `helm-selection\\=':
(helm-select-action))))
(defun helm-ff-TAB (arg)
- "Default action for TAB in `helm-find-files\\='.
+ "Default action for TAB in `helm-find-files'.
-Behave differently depending on `helm-selection\\=':
+Behave differently depending on `helm-selection':
- candidate basename is \".\" => open the action menu.
- candidate is a directory => expand it.
@@ -2303,19 +2303,19 @@ Called with a prefix arg open menu unconditionally."
(put 'helm-ff-TAB 'helm-only t)
(defun helm-ff-RET-must-match ()
- "Same as `helm-ff-RET\\=' but used in must-match map."
+ "Same as `helm-ff-RET' but used in must-match map."
(interactive)
(helm-ff-RET-1 t))
(defun helm-ff-run-grep ()
- "Run Grep action from `helm-source-find-files\\='."
+ "Run Grep action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-grep)))
(put 'helm-ff-run-grep 'helm-only t)
(defun helm-ff-run-git-grep ()
- "Run git-grep action from `helm-source-find-files\\='."
+ "Run git-grep action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-git-grep)))
@@ -2328,56 +2328,56 @@ Called with a prefix arg open menu unconditionally."
(put 'helm-ff-run-grep-ag 'helm-only t)
(defun helm-ff-run-pdfgrep ()
- "Run Pdfgrep action from `helm-source-find-files\\='."
+ "Run Pdfgrep action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-pdfgrep)))
(put 'helm-ff-run-pdfgrep 'helm-only t)
(defun helm-ff-run-zgrep ()
- "Run Grep action from `helm-source-find-files\\='."
+ "Run Grep action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-zgrep)))
(put 'helm-ff-run-zgrep 'helm-only t)
(defun helm-ff-run-copy-file ()
- "Run Copy file action from `helm-source-find-files\\='."
+ "Run Copy file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-copy)))
(put 'helm-ff-run-copy-file 'helm-only t)
(defun helm-ff-run-rsync-file ()
- "Run Rsync file action from `helm-source-find-files\\='."
+ "Run Rsync file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-rsync)))
(put 'helm-ff-run-rsync-file 'helm-only t)
(defun helm-ff-run-rename-file ()
- "Run Rename file action from `helm-source-find-files\\='."
+ "Run Rename file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-rename)))
(put 'helm-ff-run-rename-file 'helm-only t)
(defun helm-ff-run-byte-compile-file ()
- "Run Byte compile file action from `helm-source-find-files\\='."
+ "Run Byte compile file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-byte-compile)))
(put 'helm-ff-run-byte-compile-file 'helm-only t)
(defun helm-ff-run-load-file ()
- "Run Load file action from `helm-source-find-files\\='."
+ "Run Load file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-load-files)))
(put 'helm-ff-run-load-file 'helm-only t)
(defun helm-ff-run-eshell-command-on-file ()
- "Run eshell command on file action from `helm-source-find-files\\='."
+ "Run eshell command on file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action
@@ -2385,14 +2385,14 @@ Called with a prefix arg open menu unconditionally."
(put 'helm-ff-run-eshell-command-on-file 'helm-only t)
(defun helm-ff-run-ediff-file ()
- "Run Ediff file action from `helm-source-find-files\\='."
+ "Run Ediff file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-ediff-files)))
(put 'helm-ff-run-ediff-file 'helm-only t)
(defun helm-ff-run-ediff-merge-file ()
- "Run Ediff merge file action from `helm-source-find-files\\='."
+ "Run Ediff merge file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action
@@ -2400,21 +2400,21 @@ Called with a prefix arg open menu unconditionally."
(put 'helm-ff-run-ediff-merge-file 'helm-only t)
(defun helm-ff-run-symlink-file ()
- "Run Symlink file action from `helm-source-find-files\\='."
+ "Run Symlink file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-symlink)))
(put 'helm-ff-run-symlink-file 'helm-only t)
(defun helm-ff-run-relsymlink-file ()
- "Run Symlink file action from `helm-source-find-files\\='."
+ "Run Symlink file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-relsymlink)))
(put 'helm-ff-run-relsymlink-file 'helm-only t)
(defun helm-ff-run-hardlink-file ()
- "Run Hardlink file action from `helm-source-find-files\\='."
+ "Run Hardlink file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-find-files-hardlink)))
@@ -2425,14 +2425,14 @@ Called with a prefix arg open menu unconditionally."
(funcall helm-ff-delete-files-function candidate))
(defun helm-ff-run-delete-file ()
- "Run Delete file action from `helm-source-find-files\\='."
+ "Run Delete file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action #'helm-ff-delete-files)))
(put 'helm-ff-run-delete-file 'helm-only t)
(defun helm-ff-run-complete-fn-at-point ()
- "Run complete file name action from `helm-source-find-files\\='."
+ "Run complete file name action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action
@@ -2440,14 +2440,14 @@ Called with a prefix arg open menu unconditionally."
(put 'helm-ff-run-complete-fn-at-point 'helm-only t)
(defun helm-ff-run-switch-to-shell ()
- "Run switch to eshell action from `helm-source-find-files\\='."
+ "Run switch to eshell action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-switch-to-shell)))
(put 'helm-ff-run-switch-to-shell 'helm-only t)
(defun helm-ff-run-switch-other-window ()
- "Run switch to other window action from `helm-source-find-files\\='.
+ "Run switch to other window action from `helm-source-find-files'.
When a prefix arg is provided, split is done vertically."
(interactive)
(with-helm-alive-p
@@ -2455,28 +2455,28 @@ When a prefix arg is provided, split is done
vertically."
(put 'helm-ff-run-switch-other-window 'helm-only t)
(defun helm-ff-run-switch-other-frame ()
- "Run switch to other frame action from `helm-source-find-files\\='."
+ "Run switch to other frame action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'find-file-other-frame)))
(put 'helm-ff-run-switch-other-frame 'helm-only t)
(defun helm-ff-run-open-file-externally ()
- "Run open file externally command action from `helm-source-find-files\\='."
+ "Run open file externally command action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-open-file-externally)))
(put 'helm-ff-run-open-file-externally 'helm-only t)
(defun helm-ff-run-open-file-with-default-tool ()
- "Run open file externally command action from `helm-source-find-files\\='."
+ "Run open file externally command action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-open-file-with-default-tool)))
(put 'helm-ff-run-open-file-with-default-tool 'helm-only t)
(defun helm-ff-locate (candidate)
- "Locate action function for `helm-find-files\\='."
+ "Locate action function for `helm-find-files'."
(helm-locate-set-command)
(let ((default (concat (helm-basename
(expand-file-name
@@ -2493,7 +2493,7 @@ When a prefix arg is provided, split is done vertically."
(helm-locate-1 helm-current-prefix-arg nil 'from-ff default)))
(defun helm-ff-run-locate ()
- "Run locate action from `helm-source-find-files\\='."
+ "Run locate action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-locate)))
@@ -2522,14 +2522,14 @@ When a prefix arg is provided, split is done
vertically."
(put 'helm-ff-run-find-alternate-file 'helm-only t)
(defun helm-ff-run-mail-attach-files ()
- "Run mail attach files command action from `helm-source-find-files\\='."
+ "Run mail attach files command action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-mail-attach-files)))
(put 'helm-ff-run-mail-attach-files 'helm-only t)
(defun helm-ff-run-etags ()
- "Run Etags command action from `helm-source-find-files\\='."
+ "Run Etags command action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-etags-select)))
@@ -2539,14 +2539,14 @@ When a prefix arg is provided, split is done
vertically."
(defun helm-ff-print (_candidate)
"Print marked files.
-You may to set in order variables `lpr-command\\=',`lpr-switches\\='
-and/or `printer-name\\=', but with no settings Helm should detect
-your printer(s) and print with the default `lpr\\=' settings.
+You may to set in order variables `lpr-command',`lpr-switches'
+and/or `printer-name', but with no settings Helm should detect
+your printer(s) and print with the default `lpr' settings.
-NOTE: DO NOT set the \"-P\" flag in `lpr-switches\\='. If you really
-have to modify this, do it in `lpr-printer-switch\\='.
+NOTE: DO NOT set the \"-P\" flag in `lpr-switches'. If you really
+have to modify this, do it in `lpr-printer-switch'.
-Same as `dired-do-print\\=' but for Helm."
+Same as `dired-do-print' but for Helm."
(require 'lpr)
(when (or helm-current-prefix-arg
(not helm-ff-printer-list))
@@ -2585,7 +2585,7 @@ Same as `dired-do-print\\=' but for Helm."
(error "Error: Please verify your printer settings in Emacs."))))
(defun helm-ff-run-print-file ()
- "Run Print file action from `helm-source-find-files\\='."
+ "Run Print file action from `helm-source-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-print)))
@@ -2593,10 +2593,10 @@ Same as `dired-do-print\\=' but for Helm."
(defun helm-ff-checksum (file)
"Calculate the checksum of FILE.
-The checksum is copied to `kill-ring\\='.
+The checksum is copied to `kill-ring'.
Checksum is calculated with the md5sum, sha1sum, sha224sum,
sha256sum, sha384sum and sha512sum when available, otherwise the
-Emacs function `secure-hash\\=' is used but it is slow and may crash
+Emacs function `secure-hash' is used but it is slow and may crash
Emacs and even the whole system as it eats all memory."
(cl-assert (file-regular-p file)
nil "`%s' is not a regular file" file)
@@ -2684,7 +2684,7 @@ Emacs and even the whole system as it eats all memory."
(defvar helm-find-files--level-tree nil)
(defvar helm-find-files--level-tree-iterator nil)
(defun helm-find-files-up-one-level (arg)
- "Go up one level like unix command `cd ..\\='.
+ "Go up one level like unix command `cd ..'.
If prefix numeric arg is given go ARG level up."
(interactive "p")
(with-helm-alive-p
@@ -2727,7 +2727,7 @@ If prefix numeric arg is given go ARG level up."
(put 'helm-find-files-up-one-level 'helm-only t)
(defun helm-find-files-down-last-level ()
- "Retrieve previous paths reached by `C-l\\=' in helm-find-files."
+ "Retrieve previous paths reached by `C-l' in helm-find-files."
(interactive)
(with-helm-alive-p
(when (and (helm-file-completion-source-p)
@@ -2753,8 +2753,8 @@ If prefix numeric arg is given go ARG level up."
(add-hook 'helm-after-persistent-action-hook
'helm-find-files--reset-level-tree)
(defun helm-ff-retrieve-last-expanded ()
- "Move overlay to last visited directory `helm-ff-last-expanded\\='.
-This happen after using `helm-find-files-up-one-level\\=', or
+ "Move overlay to last visited directory `helm-ff-last-expanded'.
+This happen after using `helm-find-files-up-one-level', or
hitting C-j on \"..\"."
(when helm-ff-last-expanded
(let ((presel (if helm-ff-transformer-show-only-basename
@@ -2794,8 +2794,8 @@ hitting C-j on \"..\"."
(helm-next-line)))))
(defun helm-ff-undo ()
- "Undo minibuffer in `helm-find-files\\='.
-Ensure disabling `helm-ff-auto-update-flag\\=' before undoing."
+ "Undo minibuffer in `helm-find-files'.
+Ensure disabling `helm-ff-auto-update-flag' before undoing."
(interactive)
(let ((old--flag helm-ff-auto-update-flag))
(setq helm-ff-auto-update-flag nil)
@@ -2814,8 +2814,8 @@ Ensure disabling `helm-ff-auto-update-flag\\=' before
undoing."
"Expand to directory when sole completion.
When only one candidate is remaining and it is a directory,
expand to this directory.
-This happen only when `helm-ff-auto-update-flag\\=' is non-nil or
-when `helm-pattern\\=' is equal to \"~/\"."
+This happen only when `helm-ff-auto-update-flag' is non-nil or
+when `helm-pattern' is equal to \"~/\"."
(let ((src (helm-get-current-source)))
(when (and (helm-file-completion-source-p src)
(not (get-buffer-window helm-action-buffer 'visible))
@@ -2914,7 +2914,7 @@ when `helm-pattern\\=' is equal to \"~/\"."
(cl-defun helm-ff-auto-expand-to-home-or-root (&optional (pattern helm-pattern
spattern))
"Allow expanding to $HOME or \"/\" or text yanked after pattern.
-Argument PATTERN default to `helm-pattern\\=' and should _not_ be used for
+Argument PATTERN default to `helm-pattern' and should _not_ be used for
other purpose than debugging the second cond clause of this function.
When PATTERN is specified, specific helm functions are not called to
avoid errors when called outside helm for debugging purpose."
@@ -2992,9 +2992,9 @@ avoid errors when called outside helm for debugging
purpose."
(defun helm-substitute-in-filename (fname)
"Substitute all parts of FNAME from start up to \"~/\" or \"/\".
On windows system substitute from start up to \"/[[:lower:]]:/\".
-This function is needed for `helm-ff-auto-expand-to-home-or-root\\='
+This function is needed for `helm-ff-auto-expand-to-home-or-root'
and should be used carefully elsewhere, or not at all, using
-`substitute-in-file-name\\=' instead."
+`substitute-in-file-name' instead."
(cond ((and helm--url-regexp
(string-match-p helm--url-regexp fname))
fname)
@@ -3043,14 +3043,14 @@ With a prefix arg toggle dired buffer to wdired mode."
(call-interactively 'wdired-change-to-wdired-mode))))))
(defun helm-ff-run-marked-files-in-dired ()
- "Execute `helm-marked-files-in-dired\\=' interactively."
+ "Execute `helm-marked-files-in-dired' interactively."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-marked-files-in-dired)))
(put 'helm-ff-run-marked-files-in-dired 'helm-only t)
(defun helm-ff--create-tramp-name (fname)
- "Build filename from `helm-pattern\\=' like /su:: or /sudo::."
+ "Build filename from `helm-pattern' like /su:: or /sudo::."
;; `tramp-make-tramp-file-name' takes 7 args on emacs-26 whereas it
;; takes only 5 args in emacs-24/25.
(apply #'tramp-make-tramp-file-name
@@ -3070,7 +3070,7 @@ With a prefix arg toggle dired buffer to wdired mode."
((and vec (pred vectorp)) vec)))
(defun helm-ff--get-tramp-methods ()
- "Return a list of the car of `tramp-methods\\='."
+ "Return a list of the car of `tramp-methods'."
(or helm-ff--tramp-methods
(setq helm-ff--tramp-methods (mapcar 'car tramp-methods))))
@@ -3108,8 +3108,8 @@ Return nil on valid file name remote or not."
(and meth (string= bd "/") (car (last split))))))
(cl-defun helm-ff--tramp-hostnames (&optional (pattern helm-pattern))
- "Get a list of hosts for tramp method found in `helm-pattern\\='.
-Argument PATTERN default to `helm-pattern\\='. It is here only for
+ "Get a list of hosts for tramp method found in `helm-pattern'.
+Argument PATTERN default to `helm-pattern'. It is here only for
debugging purpose."
(when (string-match helm-tramp-file-name-regexp pattern)
(let* ((mh-method (helm-ff--previous-mh-tramp-method pattern))
@@ -3179,7 +3179,7 @@ debugging purpose."
thereis (string-match (format "\\`\\(/%s:.*[|]\\).*" m) name)))
(defun helm-ff-set-pattern (pattern)
- "Handle tramp filenames in `helm-pattern\\='."
+ "Handle tramp filenames in `helm-pattern'."
(let* ((methods (helm-ff--get-tramp-methods))
;; Returns the position of last ":" entered.
(postfixed (helm-ff--tramp-postfixed-p pattern))
@@ -3244,7 +3244,7 @@ debugging purpose."
(t pattern))))
(defun helm-find-files-get-candidates (&optional require-match)
- "Create candidate list for `helm-source-find-files\\='."
+ "Create candidate list for `helm-source-find-files'."
(let* ((path (helm-ff-set-pattern helm-pattern))
(dir-p (file-accessible-directory-p path))
basedir
@@ -3369,10 +3369,10 @@ debugging purpose."
(defun helm-list-directory (directory &optional sel)
"List directory DIRECTORY.
-If DIRECTORY is remote use `helm-list-directory-function\\=',
-otherwise use `directory-files\\='.
+If DIRECTORY is remote use `helm-list-directory-function',
+otherwise use `directory-files'.
SEL argument is only here for debugging purpose, it default to
-`helm-get-selection\\='."
+`helm-get-selection'."
(let* ((remote (file-remote-p directory 'method))
(helm-list-directory-function
(cond ((and remote (string= remote "ftp"))
@@ -3412,9 +3412,9 @@ SEL argument is only here for debugging purpose, it
default to
(> (nth 7 attr1) (nth 7 attr2))))
(defun helm-list-dir-lisp (directory &optional sort-method)
- "List DIRECTORY with `file-name-all-completions\\=' as backend.
+ "List DIRECTORY with `file-name-all-completions' as backend.
-Add a `helm-ff-dir\\=' property on each fname ending with \"/\"."
+Add a `helm-ff-dir' property on each fname ending with \"/\"."
;; NOTE: `file-name-all-completions' and `directory-files' and most
;; tramp file handlers don't handle cntrl characters in fnames, so
;; the displayed files will be plain wrong in this case, even worst
@@ -3440,11 +3440,11 @@ Add a `helm-ff-dir\\=' property on each fname ending
with \"/\"."
"\n" t))))
(defun helm-list-dir-adb (directory &optional sort-method)
- "List DIRECTORY with `helm-file-name-all-completions-internal\\=' as backend.
+ "List DIRECTORY with `helm-file-name-all-completions-internal' as backend.
This is used for tramp adb backend.
-Add a `helm-ff-dir\\=' property on each fname ending with \"/\"."
+Add a `helm-ff-dir' property on each fname ending with \"/\"."
(cl-loop with files = (helm-file-name-all-completions-internal directory)
for f in (sort files (or sort-method 'string-lessp))
for split = (split-string f "->" t)
@@ -3506,9 +3506,9 @@ later in the transformer."
(split-string (buffer-string) "\n" t)))))
(defcustom helm-ff-use-notify t
- "Watch directories visited with `helm-find-files\\=' when non nil.
+ "Watch directories visited with `helm-find-files' when non nil.
If your system have no file notification package available turn this
-to nil to avoid error messages when using `helm-find-files\\='."
+to nil to avoid error messages when using `helm-find-files'."
:type 'boolean
:group 'helm-files
:set (lambda (var val)
@@ -3525,8 +3525,8 @@ to nil to avoid error messages when using
`helm-find-files\\='."
(defun helm-ff-directory-files (directory &optional force-update)
"List contents of DIRECTORY.
Argument FULL mean absolute path.
-It is same as `directory-files\\=' but always returns the dotted
-filename \\='.\\=' and \\='..\\=' even on root directories in Windows
+It is same as `directory-files' but always returns the dotted
+filename '.' and '..' even on root directories in Windows
systems.
When FORCE-UPDATE is non nil recompute candidates even if DIRECTORY is
in cache."
@@ -3576,7 +3576,7 @@ in cache."
(file-notify-error (user-error "Error: %S %S" (car err) (cdr
err))))))))))
(defun helm-ff--inotify-make-callback (directory)
- "Return a callback for `file-notify-add-watch\\='."
+ "Return a callback for `file-notify-add-watch'."
(lambda (event)
(let ((desc (cadr event)))
;; `attribute-changed' means permissions have changed, not
@@ -3602,10 +3602,10 @@ in cache."
(not (memq helm-mm-matching-method '(multi1 multi3p)))))
(defun helm-ff--transform-pattern-for-completion (pattern)
- "Maybe return PATTERN with it\\='s basename modified as a regexp.
-This happens only when `helm-ff-fuzzy-matching\\=' is enabled.
-This provides a similar behavior as `ido-enable-flex-matching\\='.
-See also `helm--mapconcat-pattern\\='.
+ "Maybe return PATTERN with it's basename modified as a regexp.
+This happens only when `helm-ff-fuzzy-matching' is enabled.
+This provides a similar behavior as `ido-enable-flex-matching'.
+See also `helm--mapconcat-pattern'.
If PATTERN is an url return it unmodified.
When PATTERN contains a space fallback to multi-match.
If basename contains one or more space fallback to multi-match.
@@ -3660,7 +3660,7 @@ If PATTERN is a valid directory name, return PATTERN
unchanged."
(string-match "\\(?:/\\|\\`\\)\\.\\{1,2\\}\\'" dir))
(defun helm-ff-save-history ()
- "Store the last value of `helm-ff-default-directory\\=' in
`helm-ff-history\\='.
+ "Store the last value of `helm-ff-default-directory' in `helm-ff-history'.
Note that only existing directories are saved here."
(when (and helm-ff-default-directory
(helm-file-completion-source-p)
@@ -3673,7 +3673,7 @@ Note that only existing directories are saved here."
(defun helm-ff-valid-symlink-p (file &optional link)
"Returns the truename of FILE if it exists.
If we already know the truename of FILE we can pass it with LINK arg
-to avoid an unnecessary call to `file-truename\\='."
+to avoid an unnecessary call to `file-truename'."
(helm-aif (condition-case-unless-debug nil
;; `file-truename' send error
;; on cyclic symlinks (Bug#692).
@@ -3759,7 +3759,7 @@ to avoid an unnecessary call to `file-truename\\='."
(put 'helm-ff-persistent-delete 'helm-only t)
(defun helm-ff-dot-file-p (file)
- "Check if FILE is `.\\=' or `..\\='."
+ "Check if FILE is `.' or `..'."
(member (helm-basename file) '("." "..")))
(defun helm-ff-kill-buffer-fname (candidate)
@@ -3773,11 +3773,11 @@ to avoid an unnecessary call to `file-truename\\='."
(defun helm-ff-kill-or-find-buffer-fname (candidate)
"Find file CANDIDATE or kill its buffer if it is visible.
-Never kill `helm-current-buffer\\='.
+Never kill `helm-current-buffer'.
Never kill buffer modified.
This is called normally on third hit of \
\\<helm-map>\\[helm-execute-persistent-action]
-in `helm-find-files-persistent-action-if\\='."
+in `helm-find-files-persistent-action-if'."
(let* ((buf (get-file-buffer candidate))
(buf-name (buffer-name buf))
(win (get-buffer-window buf))
@@ -3797,7 +3797,7 @@ in `helm-find-files-persistent-action-if\\='."
(t (find-file candidate)))))
(defun helm-ff-run-kill-buffer-persistent ()
- "Execute `helm-ff-kill-buffer-fname\\=' without quitting."
+ "Execute `helm-ff-kill-buffer-fname' without quitting."
(interactive)
(with-helm-alive-p
(helm-set-attr 'kill-buffer-fname 'helm-ff-kill-buffer-fname)
@@ -3850,7 +3850,7 @@ return FNAME with display property prefixed with [?]."
(helm-score-candidate-for-pattern real pattern)))
(defun helm-ff-sort-candidates-1 (candidates input)
- "Sort function for `helm-source-find-files\\='.
+ "Sort function for `helm-source-find-files'.
Return candidates prefixed with basename of INPUT first."
(if (or (and (file-directory-p input)
(string-match "/\\'" input))
@@ -3880,8 +3880,8 @@ Return candidates prefixed with basename of INPUT first."
all)))
(defun helm-ff-sort-candidates (candidates _source)
- "Sort function for `helm-source-find-files\\='.
-Return candidates prefixed with basename of `helm-input\\=' first."
+ "Sort function for `helm-source-find-files'.
+Return candidates prefixed with basename of `helm-input' first."
(helm-ff-sort-candidates-1 candidates helm-input))
(defun helm-ff-boring-file-p (file)
@@ -3904,7 +3904,7 @@ Return candidates prefixed with basename of
`helm-input\\=' first."
(defun helm-ff-fct (candidates _source)
"Filter in charge of displaying basename or full path in HFF.
Because CANDIDATES are directly stored as (basename . full_path), when
-`helm-ff-transformer-show-only-basename\\=' is non nil do nothing and
+`helm-ff-transformer-show-only-basename' is non nil do nothing and
return directly CANDIDATES."
(if (null helm-ff-transformer-show-only-basename)
(cl-loop for (_disp . real) in candidates
@@ -3916,7 +3916,7 @@ return directly CANDIDATES."
"Transform file in a cons cell like (DISPLAY . REAL).
DISPLAY is shown as basename of FILE and REAL as full path of FILE.
If REVERSE is non nil DISPLAY is shown as full path.
-If SKIP-BORING-CHECK is non nil don\\='t filter boring files."
+If SKIP-BORING-CHECK is non nil don't filter boring files."
(let* ((basename (helm-basename file))
(dot (helm-ff-dot-file-p file))
(urlp (string-match-p helm-ff-url-regexp file))
@@ -4112,7 +4112,7 @@ Arg DISP is the display part of the candidate."
thereis (text-property-any 0 (length disp) 'face face disp)))
(defun helm-ff--is-file-from-disp (disp)
- "Return the face used for file\\='s candidate or dotted-symlink dirs."
+ "Return the face used for file's candidate or dotted-symlink dirs."
(cl-loop with len = (length disp)
for face in '(helm-ff-file
helm-ff-suid
@@ -4127,11 +4127,11 @@ Arg DISP is the display part of the candidate."
;;;###autoload
(define-minor-mode helm-ff-icon-mode
- "Display icons from `all-the-icons\\=' package in HFF when enabled.
+ "Display icons from `all-the-icons' package in HFF when enabled.
-NOTE: This mode is building `helm-source-find-files\\=', so if you enable
-it from your init file, ensure to call it _after_ your defmethod\\='s
-`helm-setup-user-source\\=' definitions (if some) to ensure they are called."
+NOTE: This mode is building `helm-source-find-files', so if you enable
+it from your init file, ensure to call it _after_ your defmethod's
+`helm-setup-user-source' definitions (if some) to ensure they are called."
:global t
(require 'all-the-icons)
(if helm-ff-icon-mode
@@ -4155,7 +4155,7 @@ it from your init file, ensure to call it _after_ your
defmethod\\='s
helm-source-find-files)))
(defun helm-find-files-action-transformer (actions candidate)
- "Action transformer for `helm-source-find-files\\='."
+ "Action transformer for `helm-source-find-files'."
(let ((str-at-point (with-helm-current-buffer
(buffer-substring-no-properties
(point-at-bol) (point-at-eol)))))
@@ -4209,7 +4209,7 @@ it from your init file, ensure to call it _after_ your
defmethod\\='s
"Execute a trash action FN on marked files.
Arg NAMES is a list of strings to pass to messages.
-E.g. \\='(\"delete\" \"deleting\")
+E.g. '(\"delete\" \"deleting\")
ARGS are other arguments to be passed to FN."
(let ((mkd (helm-marked-candidates))
@@ -4265,7 +4265,7 @@ ARGS are other arguments to be passed to FN."
The Trash directory should be a directory compliant with
<http://freedesktop.org/wiki/Specifications/trash-spec> and each
-file should have its \\='*.trashinfo\\=' correspondent file in
+file should have its '*.trashinfo' correspondent file in
Trash/info directory."
(helm-ff-trash-action 'helm-ff-trash-rm-1 '("delete" "deleting")))
@@ -4289,7 +4289,7 @@ Trash/info directory."
The Trash directory should be a directory compliant with
<http://freedesktop.org/wiki/Specifications/trash-spec> and each
-file should have its \\='*.trashinfo\\=' corresponding file in
+file should have its '*.trashinfo' corresponding file in
Trash/info directory."
(let* ((default-directory (file-name-as-directory
helm-ff-default-directory))
@@ -4301,7 +4301,7 @@ Trash/info directory."
(defun helm-restore-file-from-trash-1 (file trashed-files)
"Restore FILE from a trash directory.
Arg TRASHED-FILES is an alist of (fname_in_trash . dest) obtained
-with `helm-ff-trash-list\\='."
+with `helm-ff-trash-list'."
;; Emacs trash duplicate files with a unique name + .trashinfo in
;; the filename which is wrong, only files in info directory should
;; end with .trashinfo, so fix the filename before looking for dest name.
@@ -4334,7 +4334,7 @@ with `helm-ff-trash-list\\='."
Assume the trash system in use is freedesktop compatible, see
<http://freedesktop.org/wiki/Specifications/trash-spec>
This function is intended to be used from a trash directory i.e. it
-use `helm-ff-default-directory\\=', but it may be used elsewhere by
+use `helm-ff-default-directory', but it may be used elsewhere by
specifying the trash directory with TRASH-DIR arg."
(unless (fboundp 'system-move-file-to-trash)
;; Files owned by root are trashed in /root/.local/share/Trash.
@@ -4380,7 +4380,7 @@ E.g. \"foo:12\"."
(helm-goto-line (string-to-number linum) t))))
(defun helm-ff-mail-attach-files (_candidate)
- "Run `mml-attach-file\\=' on `helm-marked-candidates\\='."
+ "Run `mml-attach-file' on `helm-marked-candidates'."
(require 'mml)
(let ((flist (helm-marked-candidates :with-wildcard t))
(dest-buf (and (derived-mode-p 'message-mode 'mail-mode)
@@ -4518,7 +4518,7 @@ This affects directly file CANDIDATE."
(put 'helm-ff-decrease-image-size-persistent 'helm-only t)
(defun helm-ff-exif-data (candidate)
- "Extract exif data from file CANDIDATE using `helm-ff-exif-data-program\\='."
+ "Extract exif data from file CANDIDATE using `helm-ff-exif-data-program'."
(if (and helm-ff-exif-data-program
(executable-find helm-ff-exif-data-program))
(shell-command-to-string (format "%s %s %s"
@@ -4538,7 +4538,7 @@ If CANDIDATE is not a directory expand CANDIDATE filename.
If CANDIDATE is alone, open file CANDIDATE filename.
That means:
First hit on C-j expands CANDIDATE, second hit opens file.
-If a prefix arg is given or `helm-follow-mode\\=' is on, then open
+If a prefix arg is given or `helm-follow-mode' is on, then open
file."
(let* ((follow (or (helm-follow-mode-p)
helm--temp-follow-flag))
@@ -4705,7 +4705,7 @@ file."
:type 'integer)
(defun helm-ff-display-image-native-p ()
- "Use `helm-ff-display-image-native\\=' when returns `t\\='."
+ "Use `helm-ff-display-image-native' when returns `t'."
(or helm-ff-display-image-native
;; Image-dired in emacs-29 uses image-mode but
;; display is no more working with our old
@@ -4944,9 +4944,9 @@ Special commands:
;;;###autoload
(defun helm-ff-cleanup-image-dired-dir-and-cache ()
- "Cleanup `image-dired-dir\\=' directory.
+ "Cleanup `image-dired-dir' directory.
Delete all thumb files that are no more associated with an existing
-image file in `helm-ff-image-dired-thumbnails-cache\\='."
+image file in `helm-ff-image-dired-thumbnails-cache'."
(interactive)
(cl-loop for key being the hash-keys in helm-ff-image-dired-thumbnails-cache
using (hash-value val)
@@ -4996,7 +4996,7 @@ image file in `helm-ff-image-dired-thumbnails-cache\\='."
:buffer "*helm recursive dirs*")))
(defun helm-ff-recursive-dirs (_candidate)
- "Launch a recursive search in `helm-ff-default-directory\\='."
+ "Launch a recursive search in `helm-ff-default-directory'."
(with-helm-default-directory helm-ff-default-directory
(helm-find-files-recursive-dirs
(helm-current-directory)
@@ -5090,9 +5090,9 @@ arg."
(t candidate))))
(cl-defun helm-find-files-history (arg &key (comp-read t))
- "The `helm-find-files\\=' history.
-Show the first `helm-ff-history-max-length\\=' elements of
-`helm-ff-history\\=' in an `helm-comp-read\\='."
+ "The `helm-find-files' history.
+Show the first `helm-ff-history-max-length' elements of
+`helm-ff-history' in an `helm-comp-read'."
(interactive "p")
(let ((history (when helm-ff-history
(helm-fast-remove-dups helm-ff-history
@@ -5122,7 +5122,7 @@ Show the first `helm-ff-history-max-length\\=' elements of
(defvar helm-ff-drag-mouse-1-default-action 'copy
"Default action when dragging files.
-Possible values are `copy\\=', `rsync\\=' or `rename\\='.")
+Possible values are `copy', `rsync' or `rename'.")
(defvar helm-ff-drag-and-drop-default-directory nil
"Default directory where to drop files on a drag-and-drop action.
@@ -5131,13 +5131,13 @@ generally when dropping outside of an emacs frame.
You want generally to set this to your home desktop directory.")
(defun helm-ff-drag-mouse-1-fn (event)
- "Drag-and-drop function for `helm-find-files\\='.
+ "Drag-and-drop function for `helm-find-files'.
Allows dropping marked files to another frame or window.
When dropping to another frame (i.e. not the selected one where helm
is running), you are asked for which directory you want to drop to when frame
displays more than one window.
When no suitable place to drop is found ask to drop to
-`helm-ff-drag-and-drop-default-directory\\=' if set."
+`helm-ff-drag-and-drop-default-directory' if set."
(interactive "e")
(cl-assert (memq helm-ff-drag-mouse-1-default-action
'(copy rsync rename)))
@@ -5181,7 +5181,7 @@ When no suitable place to drop is found ask to drop to
(defun helm-find-files-1 (fname &optional preselect)
"Find FNAME filename with PRESELECT filename preselected.
-Use it for non-interactive calls of `helm-find-files\\='."
+Use it for non-interactive calls of `helm-find-files'."
(require 'tramp)
;; Resolve FNAME now outside of helm.
;; [FIXME] When `helm-find-files-1' is used directly from lisp
@@ -5224,9 +5224,9 @@ Use it for non-interactive calls of `helm-find-files\\='."
(setq helm-ff-default-directory nil))))
(defun helm-ff--update-resume-after-hook (sources &optional nohook)
- "Meant to be used in `helm-resume-after-hook\\='.
+ "Meant to be used in `helm-resume-after-hook'.
When NOHOOK is non-nil run inconditionally, otherwise only when
-source is `helm-source-find-files\\='."
+source is `helm-source-find-files'."
(when (or nohook (string= "Find Files"
(assoc-default 'name (car sources))))
(helm-set-attr 'resume `(lambda ()
@@ -5268,7 +5268,7 @@ source is `helm-source-find-files\\='."
:buffer "*helm ff bookmarks*"))
(defun helm-find-files-switch-to-bookmark ()
- "Switch to helm-bookmark for `helm-find-files\\=' from `helm-find-files.\\='"
+ "Switch to helm-bookmark for `helm-find-files' from `helm-find-files.'"
(interactive)
(require 'helm-bookmark)
(with-helm-alive-p
@@ -5300,7 +5300,7 @@ source is `helm-source-find-files\\='."
(thing-at-point 'filename))))))
(defun helm-ffap-guesser ()
- "Same as `ffap-guesser\\=' but without gopher and machine support."
+ "Same as `ffap-guesser' but without gopher and machine support."
(require 'ffap)
;; Avoid "Stack overflow in regexp matcher" error
;; in evil `ffap-guesser' by removing crap `ffap-gopher-at-point'
@@ -5340,7 +5340,7 @@ source is `helm-source-find-files\\='."
(if (and str ffap) str ffap)))))
(defun helm-find-files-input (file-at-pt thing-at-pt)
- "Try to guess a default input for `helm-find-files\\='."
+ "Try to guess a default input for `helm-find-files'."
(let* ((non-essential t)
(remp (or (and file-at-pt (file-remote-p file-at-pt))
(and thing-at-pt (file-remote-p thing-at-pt))))
@@ -5391,7 +5391,7 @@ source is `helm-source-find-files\\='."
(defun helm-find-library-at-point ()
"Try to find library path at point.
-Find inside `require\\=' and `declare-function\\=' sexp."
+Find inside `require' and `declare-function' sexp."
(require 'find-func)
(let* ((beg-sexp (save-excursion (search-backward "(" (point-at-bol) t)))
(end-sexp (save-excursion (ignore-errors (end-of-defun)) (point)))
@@ -5428,7 +5428,7 @@ Find inside `require\\=' and `declare-function\\=' sexp."
&key action follow (files
(dired-get-marked-files)))
"Execute ACTION on FILES to DESTINATION.
Where ACTION is a symbol that can be one of:
-\\='copy, \\='rename, \\='symlink,\\='relsymlink, \\='hardlink or \\='backup.
+'copy, 'rename, 'symlink,'relsymlink, 'hardlink or 'backup.
Argument FOLLOW when non-nil specifies to follow FILES to
DESTINATION for the actions copy and rename."
(require 'dired-async)
@@ -5504,7 +5504,7 @@ DESTINATION for the actions copy and rename."
(defun helm-get-dest-fnames-from-list (flist dest-cand rename-dir-flag)
"Transform filenames of FLIST to abs of DEST-CAND.
-If RENAME-DIR-FLAG is non-nil collect the `directory-file-name\\='
+If RENAME-DIR-FLAG is non-nil collect the `directory-file-name'
of transformed members of FLIST."
;; At this point files have been renamed/copied at destination.
;; That's mean DEST-CAND exists.
@@ -5569,7 +5569,7 @@ Return non-nil when FILE needs to be trashed."
(defun helm-trash-directory ()
"Try to find a trash directory.
Return the files subdirectory of trash directory.
-When `helm-trash-default-directory\\=' is set use it as trash directory."
+When `helm-trash-default-directory' is set use it as trash directory."
(let ((xdg-data-dir
(or helm-trash-default-directory
(directory-file-name
@@ -5582,7 +5582,7 @@ When `helm-trash-default-directory\\=' is set use it as
trash directory."
"Return FILE when it is already in trash.
Optional arg TRASH-ALIST should be an alist as what
-`helm-ff-trash-list\\=' returns."
+`helm-ff-trash-list' returns."
(unless (fboundp 'system-move-file-to-trash)
(let ((trash-files-dir (helm-trash-directory)))
(cl-loop for (_bn . fn) in (or trash-alist
@@ -5593,7 +5593,7 @@ Optional arg TRASH-ALIST should be an alist as what
"Delete file CANDIDATE without quitting.
When a prefix arg is given, meaning of
-`delete-by-moving-to-trash\\=' is the opposite."
+`delete-by-moving-to-trash' is the opposite."
(with-helm-window
(let* ((marked (helm-marked-candidates))
(trash (helm-ff--delete-by-moving-to-trash (car marked)))
@@ -5637,19 +5637,19 @@ When a prefix arg is given, meaning of
"Delete FILE after querying the user.
When a prefix arg is given, meaning of
-`delete-by-moving-to-trash\\=' is the opposite.
+`delete-by-moving-to-trash' is the opposite.
Return error when ERROR-IF-DOT-FILE-P is non-nil and user tries
to delete a dotted file i.e. \".\" or \"..\".
Ask user when directory are not empty to allow recursive deletion
-unless `helm-ff-allow-recursive-deletes\\=' is non nil.
-When user is asked and reply with \"!\" don\\='t ask for remaining
+unless `helm-ff-allow-recursive-deletes' is non nil.
+When user is asked and reply with \"!\" don't ask for remaining
directories.
Ask to kill buffers associated with that file, too.
-When TRASH is non nil, trash FILE even if `delete-by-moving-to-trash\\='
+When TRASH is non nil, trash FILE even if `delete-by-moving-to-trash'
is nil."
(require 'dired)
(cl-block nil
@@ -5706,10 +5706,10 @@ is nil."
(kill-buffer buf)))))))
(defun helm-delete-marked-files (_ignore)
- "Delete marked files with `helm-delete-file\\='.
+ "Delete marked files with `helm-delete-file'.
When a prefix arg is given, meaning of
-`delete-by-moving-to-trash\\=' is the opposite."
+`delete-by-moving-to-trash' is the opposite."
(let* ((files (helm-marked-candidates :with-wildcard t))
(len 0)
(trash (helm-ff--delete-by-moving-to-trash (car files)))
@@ -5783,12 +5783,12 @@ When a prefix arg is given, meaning of
(helm-ff--delete-async-modeline-mode -1))))
(defun helm-delete-marked-files-async (_ignore)
- "Same as `helm-delete-marked-files\\=' but async.
+ "Same as `helm-delete-marked-files' but async.
When a prefix arg is given, meaning of
-`delete-by-moving-to-trash\\=' is the opposite.
+`delete-by-moving-to-trash' is the opposite.
-This function is not using `helm-delete-file\\=' and BTW not asking
+This function is not using `helm-delete-file' and BTW not asking
user for recursive deletion of directory, be warned that
directories are always deleted with no warnings."
(let* ((files (helm-marked-candidates :with-wildcard t))
@@ -5904,7 +5904,7 @@ selecting them."
(t (find-file candidate)))))))
(defun helm-ff-find-file-other-tab ()
- "Run find file in other tab action from `helm-source-buffers-list\\='."
+ "Run find file in other tab action from `helm-source-buffers-list'."
(interactive)
(cl-assert (fboundp 'tab-bar-mode) nil "Tab-bar-mode not available")
(with-helm-alive-p
@@ -5964,7 +5964,7 @@ Else return ACTIONS unmodified."
(defun helm-file-on-mounted-network-p (file)
"Return non-nil when FILE is part of a mounted remote directory.
-This function is checking `helm-mounted-network-directories\\='
+This function is checking `helm-mounted-network-directories'
list."
(when helm-mounted-network-directories
(cl-loop for dir in helm-mounted-network-directories
@@ -5979,7 +5979,7 @@ list."
(mapc 'file-cache-add-file mkd)))
(defun helm-ff-file-cache-remove-file-1 (file)
- "Remove FILE from `file-cache-alist\\='."
+ "Remove FILE from `file-cache-alist'."
(let ((entry (assoc (helm-basename file) file-cache-alist))
(dir (helm-basedir file))
new-entry)
@@ -5990,7 +5990,7 @@ list."
(cons new-entry (remove entry file-cache-alist)))))
(defun helm-ff-file-cache-remove-file (_file)
- "Remove marked files from `file-cache-alist.\\='"
+ "Remove marked files from `file-cache-alist.'"
(let ((mkd (helm-marked-candidates)))
(mapc 'helm-ff-file-cache-remove-file-1 mkd)))
@@ -6031,7 +6031,7 @@ list."
(defvar helm--file-name-history-hide-deleted nil)
(defun helm-files-save-file-name-history (&optional force)
- "Save marked files to `file-name-history\\='."
+ "Save marked files to `file-name-history'."
(let* ((src (helm-get-current-source))
(src-name (assoc-default 'name src)))
(when (or force (helm-file-completion-source-p src)
@@ -6124,7 +6124,7 @@ list."
(message nil))))
(defun helm-ff-file-name-history ()
- "Switch to `file-name-history\\=' without quitting `helm-find-files\\='."
+ "Switch to `file-name-history' without quitting `helm-find-files'."
(interactive)
(let ((src (helm-build-sync-source "File name history"
:init (lambda ()
@@ -6191,7 +6191,7 @@ list."
:buffer-list (lambda () (helm-browse-project-get-buffers directory))))
(defun helm-browse-project-walk-directory (directory)
- "Default function for `helm-browse-project-default-find-files-fn\\='."
+ "Default function for `helm-browse-project-default-find-files-fn'."
(helm-walk-directory
directory
:directories nil :path 'full :skip-subdirs t))
@@ -6210,27 +6210,27 @@ list."
(split-string (buffer-string) "\n")))))
(defun helm-browse-project-ag-find-files (directory)
- "A suitable function for `helm-browse-project-default-find-files-fn\\='.
+ "A suitable function for `helm-browse-project-default-find-files-fn'.
Use AG as backend."
(helm-browse-project-find-files-1 directory 'ag))
(defun helm-browse-project-rg-find-files (directory)
- "A suitable function for `helm-browse-project-default-find-files-fn\\='.
+ "A suitable function for `helm-browse-project-default-find-files-fn'.
Use RG as backend."
(helm-browse-project-find-files-1 directory 'rg))
(defun helm-browse-project-fd-find-files (directory)
- "A suitable function for `helm-browse-project-default-find-files-fn\\='.
+ "A suitable function for `helm-browse-project-default-find-files-fn'.
Use FD as backend."
(helm-browse-project-find-files-1 directory 'fd))
(defun helm-browse-project-ag (_candidate)
- "A `helm-grep\\=' AG action for `helm-browse-project\\='."
+ "A `helm-grep' AG action for `helm-browse-project'."
(let ((dir (with-helm-buffer (helm-get-attr 'root-dir))))
(helm-grep-ag dir helm-current-prefix-arg)))
(defun helm-browse-project-run-ag ()
- "Run `helm-grep\\=' AG from `helm-browse-project\\='."
+ "Run `helm-grep' AG from `helm-browse-project'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-browse-project-ag)))
@@ -6256,7 +6256,7 @@ Use FD as backend."
'face 'helm-ff-file)
c)
(propertize c 'face 'helm-ff-file)))))
- "Class to define a source in `helm-browse-project\\=' handling non
+ "Class to define a source in `helm-browse-project' handling non
VC handled directories.")
(cl-defmethod helm--setup-source :after ((source
helm-browse-project-override-inheritor))
@@ -6307,12 +6307,12 @@ VC handled directories.")
"Preconfigured helm to browse projects.
Browse files and see status of project with its VCS.
Only HG and GIT are supported for now.
-Fall back to `helm-browse-project-find-files\\=' if current
+Fall back to `helm-browse-project-find-files' if current
directory is not under control of one of those VCS.
With a prefix ARG browse files recursively, with two prefix ARG
rebuild the cache.
If the current directory is found in the cache, start
-`helm-browse-project-find-files\\=' even with no prefix ARG.
+`helm-browse-project-find-files' even with no prefix ARG.
NOTE: The prefix ARG have no effect on the VCS controlled
directories.
@@ -6358,7 +6358,7 @@ and
(defun helm-ff-browse-project (_candidate)
"Browse project in current directory.
-See `helm-browse-project\\='."
+See `helm-browse-project'."
(with-helm-default-directory helm-ff-default-directory
(helm-browse-project helm-current-prefix-arg)))
@@ -6383,12 +6383,12 @@ See `helm-browse-project\\='."
;; helm-find bindings for helm-find-files.
(defun helm-ff-find-sh-command (_candidate)
- "Run `helm-find\\=' from `helm-find-files\\='."
+ "Run `helm-find' from `helm-find-files'."
(require 'helm-find)
(helm-find-1 helm-ff-default-directory))
(defun helm-ff-run-find-sh-command ()
- "Run find shell command action with key from `helm-find-files\\='."
+ "Run find shell command action with key from `helm-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-find-sh-command)))
@@ -6396,12 +6396,12 @@ See `helm-browse-project\\='."
;; helm-hd bindings for hff
(defun helm-ff-fd (_candidate)
- "Run fd shell command from `helm-find-files\\='."
+ "Run fd shell command from `helm-find-files'."
(require 'helm-fd)
(helm-fd-1 helm-ff-default-directory))
(defun helm-ff-run-fd ()
- "Run fd shell command action with key from `helm-find-files\\='."
+ "Run fd shell command action with key from `helm-find-files'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-ff-fd)))
@@ -6409,9 +6409,9 @@ See `helm-browse-project\\='."
;;;###autoload
(defun helm-find-files (arg)
- "Preconfigured `helm\\=' for helm implementation of `find-file\\='.
+ "Preconfigured `helm' for helm implementation of `find-file'.
Called with a prefix arg show history if some.
-Don\\='t call it from programs, use `helm-find-files-1\\=' instead.
+Don't call it from programs, use `helm-find-files-1' instead.
This is the starting point for nearly all actions you can do on
files."
(interactive "P")
@@ -6466,7 +6466,7 @@ files."
(defun helm-delete-tramp-connection ()
"Allow deleting tramp connection or marked tramp connections at once.
-This replace `tramp-cleanup-connection\\=' which is partially broken
+This replace `tramp-cleanup-connection' which is partially broken
in Emacs < to 25.1.50.1 (See Emacs bug
http://debbugs.gnu.org/cgi/bugreport.cgi?bug=24432).
It allows additionally to delete more than one connection at
diff --git a/helm-find.el b/helm-find.el
index aa94178329..7626639be1 100644
--- a/helm-find.el
+++ b/helm-find.el
@@ -108,7 +108,7 @@ I.e. use the -path/ipath arguments of find instead of
,@additional-options))))
(defun helm-find-shell-command-fn ()
- "Asynchronously fetch candidates for `helm-find\\='.
+ "Asynchronously fetch candidates for `helm-find'.
Additional find options can be specified after a \"*\"
separator."
(let* (process-connection-type
@@ -141,16 +141,16 @@ separator."
;;
;;;###autoload
(defun helm-find (arg)
- "Preconfigured `helm\\=' for the find shell command.
+ "Preconfigured `helm' for the find shell command.
Recursively find files whose names are matched by all specified
globbing PATTERNs under the current directory using the external
-program specified in `find-program\\=' (usually \"find\"). Every
+program specified in `find-program' (usually \"find\"). Every
input PATTERN is silently wrapped into two stars: *PATTERN*.
With prefix argument, prompt for a directory to search.
-When user option `helm-findutils-search-full-path\\=' is non-nil,
+When user option `helm-findutils-search-full-path' is non-nil,
match against complete paths, otherwise, against file names
without directory part.
diff --git a/helm-font.el b/helm-font.el
index 32ce0217e7..f3d45114ba 100644
--- a/helm-font.el
+++ b/helm-font.el
@@ -43,7 +43,7 @@
("Kill name" . helm-ucs-kill-name)
("Kill code" . helm-ucs-kill-code)
("Describe char" . helm-ucs-describe-char))
- "Actions for `helm-source-ucs\\='."
+ "Actions for `helm-source-ucs'."
:group 'helm-font
:type '(alist :key-type string :value-type function))
@@ -55,7 +55,7 @@
(define-key map (kbd "<C-right>") 'helm-ucs-persistent-forward)
(define-key map (kbd "C-c SPC") 'helm-ucs-persistent-insert-space)
map)
- "Keymap for `helm-ucs\\='.")
+ "Keymap for `helm-ucs'.")
(defface helm-ucs-char
`((((class color) (background dark))
@@ -100,7 +100,7 @@
(defvar helm-ucs--names nil)
(defvar helm-ucs-history nil)
(defvar helm-ucs-recent nil
- "Ring of recent `helm-ucs\\=' selections.")
+ "Ring of recent `helm-ucs' selections.")
(defun helm-calculate-ucs-alist-max-len (names)
"Calculate the length of the longest NAMES list candidate."
@@ -118,7 +118,7 @@
finally return (cons code char)))
(defun helm-calculate-ucs-max-len ()
- "Calculate the length of the longest `ucs-names\\=' candidate."
+ "Calculate the length of the longest `ucs-names' candidate."
(let ((ucs-struct (ucs-names)))
(if (hash-table-p ucs-struct)
(helm-calculate-ucs-hash-table-max-len ucs-struct)
@@ -172,7 +172,7 @@
(defun helm-ucs-collect-symbols (ucs-struct)
"Collect ucs symbols from UCS-STRUCT.
-Depending on the Emacs version, the variable `ucs-names\\=' can
+Depending on the Emacs version, the variable `ucs-names' can
either be an alist or a hash-table."
(if (hash-table-p ucs-struct)
(helm-ucs-collect-symbols-hash-table ucs-struct)
@@ -314,18 +314,18 @@ name."
(helm-ucs-insert-char candidate)
(helm-force-update))
:keymap helm-ucs-map)
- "Source for collecting `ucs-names\\=' math symbols.")
+ "Source for collecting `ucs-names' math symbols.")
;;;###autoload
(defun helm-select-xfont ()
- "Preconfigured `helm\\=' to select Xfont."
+ "Preconfigured `helm' to select Xfont."
(interactive)
(helm :sources 'helm-source-xfonts
:buffer "*helm select xfont*"))
;;;###autoload
(defun helm-ucs (arg)
- "Preconfigured `helm\\=' for `ucs-names\\='.
+ "Preconfigured `helm' for `ucs-names'.
Called with a prefix arg force reloading cache."
(interactive "P")
diff --git a/helm-for-files.el b/helm-for-files.el
index c12cd85975..6b36fb8e7b 100644
--- a/helm-for-files.el
+++ b/helm-for-files.el
@@ -22,7 +22,7 @@
(require 'helm-bookmark)
(defcustom helm-multi-files-toggle-locate-binding "C-c p"
- "Default binding to switch back and forth locate in `helm-multi-files\\='."
+ "Default binding to switch back and forth locate in `helm-multi-files'."
:group 'helm-files
:type 'string)
@@ -33,7 +33,7 @@
helm-source-file-cache
helm-source-files-in-current-dir
helm-source-locate)
- "Your preferred sources for `helm-for-files\\=' and `helm-multi-files\\='.
+ "Your preferred sources for `helm-for-files' and `helm-multi-files'.
When adding a source here it is up to you to ensure the library
of this source is accessible and properly loaded."
@@ -64,7 +64,7 @@ Be aware that a nil value will make tramp display very slow."
(defvar helm-source-file-cache nil)
(defcustom helm-file-cache-fuzzy-match nil
- "Enable fuzzy matching in `helm-source-file-cache\\=' when non--nil."
+ "Enable fuzzy matching in `helm-source-file-cache' when non--nil."
:group 'helm-files
:type 'boolean
:set (lambda (var val)
@@ -111,7 +111,7 @@ Be aware that a nil value will make tramp display very
slow."
pattern))))
(defcustom helm-turn-on-recentf t
- "Automatically turn on `recentf-mode\\=' when non-nil."
+ "Automatically turn on `recentf-mode' when non-nil."
:group 'helm-files
:type 'boolean)
@@ -138,11 +138,11 @@ Be aware that a nil value will make tramp display very
slow."
(defvar helm-source-recentf nil
"See (info \"(emacs)File Conveniences\").
-Set `recentf-max-saved-items\\=' to a bigger value if default is too
+Set `recentf-max-saved-items' to a bigger value if default is too
small.")
(defcustom helm-recentf-fuzzy-match nil
- "Enable fuzzy matching in `helm-source-recentf\\=' when non-nil."
+ "Enable fuzzy matching in `helm-source-recentf' when non-nil."
:group 'helm-files
:type 'boolean
:set (lambda (var val)
@@ -226,8 +226,8 @@ Colorize only symlinks, directories and files."
;;;###autoload
(defun helm-for-files ()
- "Preconfigured `helm\\=' for opening files.
-Run all sources defined in `helm-for-files-preferred-list\\='."
+ "Preconfigured `helm' for opening files.
+Run all sources defined in `helm-for-files-preferred-list'."
(interactive)
(require 'helm-x-files)
(unless helm-source-buffers-list
@@ -257,10 +257,10 @@ Run all sources defined in
`helm-for-files-preferred-list\\='."
;;;###autoload
(defun helm-multi-files ()
- "Preconfigured helm like `helm-for-files\\=' but running locate only on
demand.
+ "Preconfigured helm like `helm-for-files' but running locate only on demand.
Allow toggling back and forth from locate to others sources with
-`helm-multi-files-toggle-locate-binding\\=' key.
+`helm-multi-files-toggle-locate-binding' key.
This avoids launching locate needlessly when what you are
searching for is already found."
(interactive)
@@ -299,7 +299,7 @@ searching for is already found."
;;;###autoload
(defun helm-recentf ()
- "Preconfigured `helm\\=' for `recentf\\='."
+ "Preconfigured `helm' for `recentf'."
(interactive)
(helm :sources 'helm-source-recentf
:ff-transformer-show-only-basename nil
diff --git a/helm-global-bindings.el b/helm-global-bindings.el
index 4031fb5f62..896df8b60d 100644
--- a/helm-global-bindings.el
+++ b/helm-global-bindings.el
@@ -26,7 +26,7 @@
(defcustom helm-command-prefix-key
(helm-aif (car (where-is-internal 'Control-X-prefix (list global-map)))
(concat it [?c]))
- "The key `helm-command-prefix\\=' is bound to in the global map."
+ "The key `helm-command-prefix' is bound to in the global map."
:type '(choice (string :tag "Key") (const :tag "no binding"))
:group 'helm-config
:set
diff --git a/helm-grep.el b/helm-grep.el
index c0b986f2b5..c7fae927e5 100644
--- a/helm-grep.el
+++ b/helm-grep.el
@@ -49,28 +49,28 @@
(defcustom helm-grep-default-command
"grep --color=always -a -d skip %e -n%cH -e %p %f"
- "Default grep format command for `helm-do-grep-1\\='.
+ "Default grep format command for `helm-do-grep-1'.
Where:
-\\='%e\\=' format spec is for --exclude or --include grep options or
+'%e' format spec is for --exclude or --include grep options or
ack-grep --type option. (Not mandatory)
-\\='%c\\=' format spec is for case-fold-search,
+'%c' format spec is for case-fold-search,
whether to use the -i option of grep. (Not mandatory)
When you specify this spec, helm grep will use smartcase
that is when a upcase character is found in pattern case will
- be respected and no \\='-i\\=' option will be used, otherwise, when
- no upcase character is found in pattern always use \\='-i\\='.
- If you don\\='t want this behavior, don\\='t use this spec and
- specify or not the \\='-i\\=' option.
+ be respected and no '-i' option will be used, otherwise, when
+ no upcase character is found in pattern always use '-i'.
+ If you don't want this behavior, don't use this spec and
+ specify or not the '-i' option.
Note that with ack-grep this is not needed, just specify
- the \\='--smart-case\\=' option.
+ the '--smart-case' option.
-\\='%p\\=' format spec is for pattern. (Mandatory)
+'%p' format spec is for pattern. (Mandatory)
-\\='%f\\=' format spec is for filenames. (Mandatory)
+'%f' format spec is for filenames. (Mandatory)
-If your grep version doesn\\='t support the --exclude/include args
-don\\='t specify the \\='%e\\=' format spec.
+If your grep version doesn't support the --exclude/include args
+don't specify the '%e' format spec.
Helm also support ack-grep and git-grep. The following is a
default command example for ack-grep:
@@ -80,7 +80,7 @@ default command example for ack-grep:
helm-grep-default-recurse-command
\"ack-grep -H --color --smart-case --no-group %e -- %p %f\")
-You can ommit the %e spec if you don\\='t want to be prompted for
+You can ommit the %e spec if you don't want to be prompted for
types.
NOTE: Helm for ack-grep support ANSI sequences, so you can remove
@@ -90,7 +90,7 @@ because ack disable it when output is piped.
Same for grep you can use safely the option \"--color=always\" (default).
You can customize the color of matches using GREP_COLORS env var.
-e.g: (setenv \"GREP_COLORS\"
+e.g: \(setenv \"GREP_COLORS\"
\"ms=30;43:mc=30;43:sl=01;37:cx=:fn=35:ln=32:bn=32:se=36\")
To enable ANSI color in git-grep just add \"--color=always\".
@@ -103,10 +103,10 @@ you will have to setup this in your .gitconfig:
Where \"black\" is the foreground and \"yellow\" the background.
See the git documentation for more infos.
-`helm-grep-default-command\\=' and
-`helm-grep-default-recurse-command\\=' are independent, so you can
-enable `helm-grep-default-command\\=' with ack-grep and
-`helm-grep-default-recurse-command\\=' with grep if you want to be
+`helm-grep-default-command' and
+`helm-grep-default-recurse-command' are independent, so you can
+enable `helm-grep-default-command' with ack-grep and
+`helm-grep-default-recurse-command' with grep if you want to be
faster on recursive grep.
NOTE: Remote grepping is not available with ack-grep, and badly
@@ -117,8 +117,8 @@ NOTE: Remote grepping is not available with ack-grep, and
badly
(defcustom helm-grep-default-recurse-command
"grep --color=always -a -d recurse %e -n%cH -e %p %f"
- "Default recursive grep format command for `helm-do-grep-1\\='.
-See `helm-grep-default-command\\=' for format specs and infos about
+ "Default recursive grep format command for `helm-do-grep-1'.
+See `helm-grep-default-command' for format specs and infos about
ack-grep."
:group 'helm-grep
:type 'string)
@@ -126,10 +126,10 @@ ack-grep."
(defcustom helm-default-zgrep-command
"zgrep --color=always -a -n%cH -e %p %f"
"Default command for Zgrep.
-See `helm-grep-default-command\\=' for infos on format specs.
+See `helm-grep-default-command' for infos on format specs.
Option --color=always is supported and can be used safely to
replace the Helm internal match highlighting. See
-`helm-grep-default-command\\=' for more infos."
+`helm-grep-default-command' for more infos."
:group 'helm-grep
:type 'string)
@@ -153,18 +153,18 @@ GREP_COLORS env var."
(defcustom helm-pdfgrep-default-read-command nil
"Default command to read pdf files from pdfgrep.
-Where \\='%f\\=' format spec is filename and \\='%p\\=' is page number.
+Where '%f' format spec is filename and '%p' is page number.
E.g. In Ubuntu you can set it to:
- \"evince --page-label=%p \\='%f\\='\"
+ \"evince --page-label=%p '%f'\"
-If set to nil either `doc-view-mode\\=' or `pdf-view-mode\\=' will be
+If set to nil either `doc-view-mode' or `pdf-view-mode' will be
used instead of an external command."
:group 'helm-grep
:type 'string)
(defcustom helm-grep-max-length-history 100
- "Max number of elements to save in `helm-grep-history\\='."
+ "Max number of elements to save in `helm-grep-history'."
:group 'helm-grep
:type 'integer)
@@ -189,13 +189,13 @@ used instead of an external command."
(unless (string-match-p "/\\'" s)
(concat "*" s)))
completion-ignored-extensions)))
- "List of file names which `helm-grep\\=' shall exclude."
+ "List of file names which `helm-grep' shall exclude."
:group 'helm-grep
:type '(repeat string))
(defcustom helm-grep-ignored-directories
helm-walk-ignore-directories
- "List of names of sub-directories which `helm-grep\\=' shall not recurse
into."
+ "List of names of sub-directories which `helm-grep' shall not recurse into."
:group 'helm-grep
:type '(repeat string))
@@ -236,7 +236,7 @@ Here are the commands where you may want to add switches:
grep --color=always
ack-grep --smart-case --color
-You probably don\\='t need to use this unless you know what you are
+You probably don't need to use this unless you know what you are
doing."
:group 'helm-grep
:type '(repeat string))
@@ -251,12 +251,12 @@ Here are the commands where you may want to add switches:
rg -N -S --color=?
For RG the value of --color= is computed according to the --color=
-value used in `helm-grep-ag-command\\='.
+value used in `helm-grep-ag-command'.
-Note also that by default the \"--\" option is always used, you don\\='t
+Note also that by default the \"--\" option is always used, you don't
need to add it here.
-You probably don\\='t need to use this unless you know what you are
+You probably don't need to use this unless you know what you are
doing."
:group 'helm-grep
:type '(repeat string))
@@ -332,7 +332,7 @@ Have no effect when grep backend use \"--color=\"."
(defcustom helm-grep-use-ioccur-style-keys t
"Use Arrow keys to jump to occurences.
-Note that if you define this variable with `setq\\=' your change
+Note that if you define this variable with `setq' your change
will have no effect, use customize instead."
:group 'helm-grep
:type 'boolean
@@ -383,7 +383,7 @@ will have no effect, use customize instead."
(defvar helm-grep-use-zgrep nil)
(defvar helm-grep-default-directory-fn nil
"A function that should return a directory to expand candidate to.
-It is intended to use as a let-bound variable, DON\\='T set this globaly.")
+It is intended to use as a let-bound variable, DON'T set this globaly.")
(defvar helm-pdfgrep-targets nil)
(defvar helm-grep-last-cmd-line nil)
(defvar helm-grep-split-line-regexp
"^\\([[:lower:][:upper:]]?:?.*?\\):\\([0-9]+\\):\\(.*\\)")
@@ -647,8 +647,8 @@ It is intended to use as a let-bound variable, DON\\='T set
this globaly.")
;;
;;
(defun helm-grep-action (candidate &optional where)
- "Define a default action for `helm-do-grep-1\\=' on CANDIDATE.
-WHERE can be `other-window\\=' or `other-frame\\='."
+ "Define a default action for `helm-do-grep-1' on CANDIDATE.
+WHERE can be `other-window' or `other-frame'."
(let* ((split (helm-grep-split-line candidate))
(split-pat (helm-mm-split-pattern helm-input))
(lineno (string-to-number (nth 1 split)))
@@ -703,8 +703,8 @@ WHERE can be `other-window\\=' or `other-frame\\='."
helm-grep-history))))))
(defun helm-grep-persistent-action (candidate)
- "Persistent action for `helm-do-grep-1\\='.
-With a prefix arg record CANDIDATE in `mark-ring\\='."
+ "Persistent action for `helm-do-grep-1'.
+With a prefix arg record CANDIDATE in `mark-ring'."
(helm-grep-action candidate)
(helm-highlight-current-line))
@@ -776,28 +776,28 @@ If N is positive go forward otherwise go backward."
(helm-goto-next-or-prec-file 1)))
(defun helm-grep-run-default-action ()
- "Run grep default action from `helm-do-grep-1\\='."
+ "Run grep default action from `helm-do-grep-1'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-grep-action)))
(put 'helm-grep-run-default-action 'helm-only t)
(defun helm-grep-run-other-window-action ()
- "Run grep goto other window action from `helm-do-grep-1\\='."
+ "Run grep goto other window action from `helm-do-grep-1'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-grep-other-window)))
(put 'helm-grep-run-other-window-action 'helm-only t)
(defun helm-grep-run-other-frame-action ()
- "Run grep goto other frame action from `helm-do-grep-1\\='."
+ "Run grep goto other frame action from `helm-do-grep-1'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-grep-other-frame)))
(put 'helm-grep-run-other-frame-action 'helm-only t)
(defun helm-grep-run-save-buffer ()
- "Run grep save results action from `helm-do-grep-1\\='."
+ "Run grep save results action from `helm-do-grep-1'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-grep-save-results)))
@@ -819,7 +819,7 @@ If N is positive go forward otherwise go backward."
(defvar helm-grep-mode-use-pcre nil)
(defun helm-grep-save-results-1 ()
- "Save Helm grep result in a `helm-grep-mode\\=' buffer."
+ "Save Helm grep result in a `helm-grep-mode' buffer."
(let* ((buf "*hgrep*")
new-buf
(pattern (with-helm-buffer helm-input-local))
@@ -880,9 +880,9 @@ If N is positive go forward otherwise go backward."
(put 'helm-grep-mode-mouse-jump 'helm-only t)
(defun helm-grep-next-error (&optional argp reset)
- "Goto ARGP position from a `helm-grep-mode\\=' buffer.
+ "Goto ARGP position from a `helm-grep-mode' buffer.
RESET non-nil means rewind to the first match.
-This is the `next-error-function\\=' for `helm-grep-mode\\='."
+This is the `next-error-function' for `helm-grep-mode'."
(interactive "p")
(goto-char (cond (reset (point-min))
((< argp 0) (line-beginning-position))
@@ -898,11 +898,11 @@ This is the `next-error-function\\=' for
`helm-grep-mode\\='."
;;;###autoload
(defun helm-revert-next-error-last-buffer ()
- "Revert last `next-error\\=' buffer from `current-buffer\\='.
+ "Revert last `next-error' buffer from `current-buffer'.
-Accept to revert only `helm-grep-mode\\=' or `helm-occur-mode\\=' buffers.
-Use this when you want to revert the `next-error\\=' buffer after
-modifications in `current-buffer\\='."
+Accept to revert only `helm-grep-mode' or `helm-occur-mode' buffers.
+Use this when you want to revert the `next-error' buffer after
+modifications in `current-buffer'."
(interactive)
(let ((buffer (next-error-find-buffer))
(linum (line-number-at-pos))
@@ -1059,7 +1059,7 @@ Special commands:
(defvar helm-grep-ack-types-cache nil)
(defun helm-grep-read-ack-type ()
- "Select types for the \\='--type\\=' argument of ack-grep."
+ "Select types for the '--type' argument of ack-grep."
(require 'helm-mode)
(require 'helm-adaptive)
(setq helm-grep-ack-types-cache (helm-grep-hack-types))
@@ -1099,7 +1099,7 @@ of grep."
finally return (delq nil (append ext-list glob-list))))
(defun helm-grep-get-file-extensions (files)
- "Try to return a list of file extensions to pass to \\='--include\\=' arg of
grep."
+ "Try to return a list of file extensions to pass to '--include' arg of grep."
(require 'helm-adaptive)
(let* ((all-exts (helm-grep-guess-extensions
(mapcar 'expand-file-name files)))
@@ -1140,8 +1140,8 @@ of grep."
:documentation
" The grep backend that will be used.
It is actually used only as an internal flag
- and doesn\\='t set the backend by itself.
- You probably don\\='t want to modify this.")
+ and doesn't set the backend by itself.
+ You probably don't want to modify this.")
(candidate-number-limit :initform 9999)
(help-message :initform 'helm-grep-help-message)
(history :initform 'helm-grep-history)
@@ -1169,7 +1169,7 @@ of grep."
default-input input (source
'helm-source-grep))
"Launch helm using backend BACKEND on a list of TARGETS files.
-When RECURSE is given and BACKEND is \\='grep\\=' use -r option of
+When RECURSE is given and BACKEND is 'grep' use -r option of
BACKEND and prompt user for EXTS to set the --include args of
BACKEND.
Interactively you can give more than one arg separated by space
@@ -1180,16 +1180,16 @@ E.g.:
From Lisp use the EXTS argument as a list of extensions as above.
If you are using ack-grep, you will be prompted for --type
instead and EXTS will be ignored. If prompt is empty
-`helm-grep-ignored-files\\=' are added to --exclude.
+`helm-grep-ignored-files' are added to --exclude.
-Argument DEFAULT-INPUT is use as `default\\=' arg of `helm\\=' and
-INPUT is used as `input\\=' arg of `helm\\='. See `helm\\=' docstring.
+Argument DEFAULT-INPUT is use as `default' arg of `helm' and
+INPUT is used as `input' arg of `helm'. See `helm' docstring.
Arg BACKEND when non-nil specifies which backend to use.
-It is used actually to specify \\='zgrep\\=' or \\='git\\='.
-When BACKEND \\='zgrep\\=' is used don\\='t prompt for a choice in
+It is used actually to specify 'zgrep' or 'git'.
+When BACKEND 'zgrep' is used don't prompt for a choice in
recurse, and ignore EXTS, search being made recursively on files
-matching `helm-zgrep-file-extension-regexp\\=' only."
+matching `helm-zgrep-file-extension-regexp' only."
(let* (non-essential
(ack-rec-p (helm-grep-use-ack-p :where 'recursive))
(exts (and recurse
@@ -1326,7 +1326,7 @@ matching `helm-zgrep-file-extension-regexp\\=' only."
"")))
(defun helm-grep-filter-one-by-one (candidate &optional pcre)
- "`filter-one-by-one\\=' transformer function for `helm-do-grep-1\\='."
+ "`filter-one-by-one' transformer function for `helm-do-grep-1'."
(let ((helm-grep-default-directory-fn
(or helm-grep-default-directory-fn
(lambda () (or helm-ff-default-directory
@@ -1351,7 +1351,7 @@ matching `helm-zgrep-file-extension-regexp\\=' only."
collect (helm-grep--filter-candidate-1 c nil pcre))))
(defun helm-grep-highlight-match (str &optional pcre)
- "Highlight in string STR all occurences matching `helm-pattern\\='."
+ "Highlight in string STR all occurences matching `helm-pattern'."
(let (beg end)
(condition-case-unless-debug nil
(with-temp-buffer
@@ -1388,7 +1388,7 @@ matching `helm-zgrep-file-extension-regexp\\=' only."
If one of selected buffers is not a file buffer, it is ignored
and grep will run on all others file-buffers.
If only one candidate is selected and it is not a file buffer,
-switch to this buffer and run `helm-occur\\='.
+switch to this buffer and run `helm-occur'.
If a prefix arg is given run grep on all buffers ignoring
non-file buffers."
(let* ((prefarg (or current-prefix-arg helm-current-prefix-arg))
@@ -1546,7 +1546,7 @@ For ripgrep here is the command line to use:
And to customize colors (always for ripgrep) use something like this:
- rg --color=always --colors \\='match:bg:yellow\\=' --colors
\\='match:fg:black\\='
+ rg --color=always --colors 'match:bg:yellow' --colors 'match:fg:black'
\--smart-case --no-heading --line-number %s -- %s %s
This will change color for matched items from foreground red (the
@@ -1568,7 +1568,7 @@ ones to use.
When modifying the default colors of matches with e.g.
\"--color-match\" option of AG or \"--colors\" option of ripgrep
-you may want to modify as well `helm-grep-ag-pipe-cmd-switches\\='
+you may want to modify as well `helm-grep-ag-pipe-cmd-switches'
to have all matches colorized with the same color in multi
match.
@@ -1601,7 +1601,7 @@ Ripgrep (rg) types are also supported if this backend is
used."
(defun helm-grep-ag-prepare-cmd-line (pattern directory &optional type)
"Prepare AG command line to search PATTERN in DIRECTORY.
-When TYPE is specified it is one of what `helm-grep-ag-get-types\\='
+When TYPE is specified it is one of what `helm-grep-ag-get-types'
returns if available with current AG version."
(let* ((patterns (helm-mm-split-pattern pattern t))
(pipe-switches (mapconcat 'identity helm-grep-ag-pipe-cmd-switches "
"))
@@ -1755,7 +1755,7 @@ When WITH-TYPES is non-nil provide completion on AG
types."
"The git grep default command line.
The option \"--color=always\" can be used safely.
The color of matched items can be customized in your .gitconfig
-See `helm-grep-default-command\\=' for more infos.
+See `helm-grep-default-command' for more infos.
The \"--exclude-standard\" and \"--no-index\" switches allow
skipping unwanted files specified in ~/.gitignore_global and
@@ -1771,7 +1771,7 @@ You have also to enable this in global \".gitconfig\" with
If DIRECTORY is not inside or part of a git repo exit with error.
If optional arg ALL is non-nil grep the whole repo otherwise
start at DIRECTORY.
-Arg DEFAULT is what you will have with `next-history-element\\=',
+Arg DEFAULT is what you will have with `next-history-element',
arg INPUT is what you will have by default at prompt on startup."
(require 'vc)
(let* (helm-grep-default-recurse-command
@@ -1787,7 +1787,7 @@ arg INPUT is what you will have by default at prompt on
startup."
;;;###autoload
(defun helm-do-grep-ag (arg)
- "Preconfigured `helm\\=' for grepping with AG in `default-directory\\='.
+ "Preconfigured `helm' for grepping with AG in `default-directory'.
With prefix arg prompt for type if available with your AG
version."
(interactive "P")
@@ -1796,7 +1796,7 @@ version."
;;;###autoload
(defun helm-grep-do-git-grep (arg)
- "Preconfigured `helm\\=' for git-grepping `default-directory\\='.
+ "Preconfigured `helm' for git-grepping `default-directory'.
With a prefix arg ARG git-grep the whole repository."
(interactive "P")
(require 'helm-files)
diff --git a/helm-help.el b/helm-help.el
index b6b627b716..cafdddc604 100644
--- a/helm-help.el
+++ b/helm-help.el
@@ -20,7 +20,7 @@
(defgroup helm-help nil
- "Embedded help for `helm\\='."
+ "Embedded help for `helm'."
:group 'helm)
(defface helm-helper
@@ -51,13 +51,13 @@
helm-semantic-help-message
helm-kmacro-help-message
helm-kill-ring-help-message)
- "A list of help messages (strings) used by `helm-documentation\\='.")
+ "A list of help messages (strings) used by `helm-documentation'.")
(defvar helm-documentation-buffer-name "*helm documentation*")
;;;###autoload
(defun helm-documentation ()
- "Preconfigured `helm\\=' for Helm documentation.
+ "Preconfigured `helm' for Helm documentation.
With a prefix arg refresh the documentation.
Find here the documentation of all documented sources."
@@ -2478,7 +2478,7 @@ C/\\[helm-cr-empty-string]:Empty \
f1/f2/f-n:NthAct \
\\[helm-toggle-suspend-update]:Tog.suspend \
\\[helm-customize-group]:Conf"
- "String displayed in mode-line in `helm-source-find-files\\='.")
+ "String displayed in mode-line in `helm-source-find-files'.")
;;;###autoload
(defvar helm-top-mode-line "\
diff --git a/helm-id-utils.el b/helm-id-utils.el
index e0a6e81767..0ff71e5246 100644
--- a/helm-id-utils.el
+++ b/helm-id-utils.el
@@ -25,16 +25,16 @@
:group 'helm)
(defcustom helm-gid-program "gid"
- "Name of gid command (usually `gid\\=').
-For Mac OS X users, if you install GNU coreutils, the name `gid\\='
-might be occupied by `id\\=' from GNU coreutils, and you should set
+ "Name of gid command (usually `gid').
+For Mac OS X users, if you install GNU coreutils, the name `gid'
+might be occupied by `id' from GNU coreutils, and you should set
it to correct name (or absolute path). For example, if using
-MacPorts to install id-utils, it should be `gid32\\='."
+MacPorts to install id-utils, it should be `gid32'."
:group 'helm-id-utils
:type 'file)
(defcustom helm-gid-db-file-name "ID"
- "Name of a database file created by `mkid\\=' command from `ID-utils\\='."
+ "Name of a database file created by `mkid' command from `ID-utils'."
:group 'helm-id-utils
:type 'string)
@@ -101,10 +101,10 @@ MacPorts to install id-utils, it should be `gid32\\='."
;;;###autoload
(defun helm-gid ()
- "Preconfigured `helm\\=' for `gid\\=' command line of `ID-Utils\\='.
-Need A database created with the command `mkid\\=' above
-`default-directory\\='.
-Need id-utils as dependency which provide `mkid\\=', `gid\\=' etc..
+ "Preconfigured `helm' for `gid' command line of `ID-Utils'.
+Need A database created with the command `mkid' above
+`default-directory'.
+Need id-utils as dependency which provide `mkid', `gid' etc..
See <https://www.gnu.org/software/idutils/>."
(interactive)
(let* ((db (locate-dominating-file
diff --git a/helm-imenu.el b/helm-imenu.el
index 5f68e25bd0..71cbe29e24 100644
--- a/helm-imenu.el
+++ b/helm-imenu.el
@@ -39,7 +39,7 @@
:group 'helm)
(defcustom helm-imenu-delimiter " / "
- "Delimit types of candidates and their value in `helm-buffer\\='."
+ "Delimit types of candidates and their value in `helm-buffer'."
:group 'helm-imenu
:type 'string)
@@ -50,11 +50,11 @@
:type 'function)
(defcustom helm-imenu-all-buffer-assoc nil
- "Major mode association alist for `helm-imenu-in-all-buffers\\='.
-Allow `helm-imenu-in-all-buffers\\=' searching in these associated
+ "Major mode association alist for `helm-imenu-in-all-buffers'.
+Allow `helm-imenu-in-all-buffers' searching in these associated
buffers even if they are not derived from each other. The alist
-is bidirectional, i.e. no need to add \\='((foo . bar) (bar . foo)),
-only \\='((foo . bar)) is needed."
+is bidirectional, i.e. no need to add '((foo . bar) (bar . foo)),
+only '((foo . bar)) is needed."
:type '(alist :key-type symbol :value-type symbol)
:group 'helm-imenu)
@@ -64,10 +64,10 @@ only \\='((foo . bar)) is needed."
When nil all candidates are displayed in a single source.
NOTE: Each source will have as name \"Imenu <buffer-name>\".
-`helm-source-imenu-all\\=' will not be set, however it will continue
+`helm-source-imenu-all' will not be set, however it will continue
to be used as a flag for using default as input. If you do not
want this behavior, remove it from
-`helm-sources-using-default-as-input\\=' even if not using a single
+`helm-sources-using-default-as-input' even if not using a single
source to display imenu in all buffers."
:type 'boolean
:group 'helm-imenu)
@@ -88,7 +88,7 @@ string."
(sexp :tag "Face"))))
(defcustom helm-imenu-extra-modes nil
- "Extra modes where `helm-imenu-in-all-buffers\\=' should look into."
+ "Extra modes where `helm-imenu-in-all-buffers' should look into."
:group 'helm-imenu
:type '(repeat symbol))
@@ -177,7 +177,7 @@ This value can be toggled with
\\<helm-imenu-map>\\[helm-imenu-toggle-type-view]
("Variable" . (all-the-icons-octicon "book" :face
font-lock-variable-name-face))
("Variables" . (all-the-icons-octicon "book":face
font-lock-variable-name-face)))
"An alist of types associated with a sexp returning an icon.
-The sexp should be an `all-the-icons\\=' function with its args."
+The sexp should be an `all-the-icons' function with its args."
:type '(alist :key-type string :value-type sexp)
:group 'helm-imenu)
@@ -282,7 +282,7 @@ The sexp should be an `all-the-icons\\=' function with its
args."
(group :initform 'helm-imenu)))
(defcustom helm-imenu-fuzzy-match nil
- "Enable fuzzy matching in `helm-source-imenu\\='."
+ "Enable fuzzy matching in `helm-source-imenu'."
:group 'helm-imenu
:type 'boolean
:set (lambda (var val)
@@ -318,7 +318,7 @@ The sexp should be an `all-the-icons\\=' function with its
args."
(buffer-file-name (marker-buffer (cdr sel))))))
(defun helm-imenu-action (candidate)
- "Default action for `helm-source-imenu\\='."
+ "Default action for `helm-source-imenu'."
(helm-log-run-hook 'helm-goto-line-before-hook)
(helm-imenu--maybe-switch-to-buffer candidate)
(imenu candidate)
@@ -331,7 +331,7 @@ The sexp should be an `all-the-icons\\=' function with its
args."
(helm-highlight-current-line)))
(defun helm-imenu-persistent-action (candidate)
- "Default persistent action for `helm-source-imenu\\='."
+ "Default persistent action for `helm-source-imenu'."
(helm-imenu--maybe-switch-to-buffer candidate)
(imenu candidate)
(helm-highlight-current-line))
@@ -418,8 +418,8 @@ The sexp should be an `all-the-icons\\=' function with its
args."
(defun helm-imenu-icon-for-type (type)
"Return an icon for type TYPE.
-The icon is found in `helm-imenu-icon-type-alist\\=', if not
-`helm-imenu-default-type-sexp\\=' is evaled to provide a default icon."
+The icon is found in `helm-imenu-icon-type-alist', if not
+`helm-imenu-default-type-sexp' is evaled to provide a default icon."
(require 'all-the-icons)
(let ((all-the-icons-scale-factor 1.0)
(all-the-icons-default-adjust 0.0))
@@ -470,7 +470,7 @@ The icon is found in `helm-imenu-icon-type-alist\\=', if not
;;;###autoload
(defun helm-imenu ()
- "Preconfigured `helm\\=' for `imenu\\='."
+ "Preconfigured `helm' for `imenu'."
(interactive)
(require 'which-func)
(unless helm-source-imenu
@@ -494,8 +494,8 @@ The icon is found in `helm-imenu-icon-type-alist\\=', if not
(defun helm-imenu-in-all-buffers ()
"Fetch Imenu entries in all buffers with similar mode as current.
A mode is similar as current if it is the same, it is derived
-i.e. `derived-mode-p\\=' or it have an association in
-`helm-imenu-all-buffer-assoc\\='."
+i.e. `derived-mode-p' or it have an association in
+`helm-imenu-all-buffer-assoc'."
(interactive)
(require 'which-func)
(unless helm-imenu-in-all-buffers-separate-sources
diff --git a/helm-info.el b/helm-info.el
index 0658c56885..e996c09634 100644
--- a/helm-info.el
+++ b/helm-info.el
@@ -44,7 +44,7 @@
helm-source-info-eieio
helm-source-info-pages)
"Default sources to use for looking up symbols at point in Info
-files with `helm-info-at-point\\='."
+files with `helm-info-at-point'."
:group 'helm-info
:type '(repeat (choice symbol)))
@@ -72,7 +72,7 @@ found in each node, otherwise scan only the current info
buffer."
(defun helm-info-scan-current-buffer (tobuf)
"Scan current info buffer and print lines to TOBUF.
-Argument TOBUF is the `helm-candidate-buffer\\='."
+Argument TOBUF is the `helm-candidate-buffer'."
(let (start end line)
(goto-char (point-min))
(while (search-forward "\n* " nil t)
@@ -107,7 +107,7 @@ a line like this:
\* bind: Bash Builtins. (line 21).")
(defun helm-info-display-to-real (line)
- "Transform LINE to an acceptable argument for `info\\='.
+ "Transform LINE to an acceptable argument for `info'.
If line have a node use the node, otherwise use directly first name found."
(let (nodename linum)
(when (string-match helm-info--node-regexp line)
@@ -140,7 +140,7 @@ If line have a node use the node, otherwise use directly
first name found."
(defun helm-build-info-index-command (name doc source buffer)
"Define a Helm command NAME with documentation DOC.
Arg SOURCE will be an existing helm source named
-`helm-source-info-<NAME>\\=' and BUFFER a string buffer name."
+`helm-source-info-<NAME>' and BUFFER a string buffer name."
(defalias (intern (concat "helm-info-" name))
(lambda ()
(interactive)
@@ -152,10 +152,10 @@ Arg SOURCE will be an existing helm source named
(defun helm-define-info-index-sources (var-value &optional commands)
"Define Helm sources named helm-source-info-<NAME>.
Sources are generated for all entries of
-`helm-default-info-index-list\\='.
+`helm-default-info-index-list'.
If COMMANDS arg is non-nil, also build commands named
-`helm-info-<NAME>\\='.
-Where NAME is an element of `helm-default-info-index-list\\='."
+`helm-info-<NAME>'.
+Where NAME is an element of `helm-default-info-index-list'."
(cl-loop for str in var-value
for sym = (intern (concat "helm-source-info-" str))
do (set sym (helm-build-info-source str))
@@ -177,12 +177,12 @@ Where NAME is an element of
`helm-default-info-index-list\\='."
"Ring of previously searched Info files.")
(defun helm-get-info-files ()
- "Return list of Info files to use for `helm-info\\='.
+ "Return list of Info files to use for `helm-info'.
Elements of the list are strings of Info file names without
extensions (e.g., \"emacs\" for file \"emacs.info.gz\"). Info
files are found by searching directories in
-`Info-directory-list\\='."
+`Info-directory-list'."
(info-initialize) ; Build Info-directory-list from INFOPATH (Bug#2118)
(let ((files (cl-loop for d in (or Info-directory-list
Info-default-directory-list)
@@ -195,13 +195,13 @@ files are found by searching directories in
(defcustom helm-default-info-index-list
(helm-get-info-files)
- "Info files to search in with `helm-info\\='."
+ "Info files to search in with `helm-info'."
:group 'helm-info
:type '(repeat (choice string))
:set 'helm-info-index-set)
(defun helm-info-search-index (candidate)
- "Search the index of CANDIDATE\\='s Info file using the function
+ "Search the index of CANDIDATE's Info file using the function
helm-info-<CANDIDATE>."
(let ((helm-info-function
(intern-soft (concat "helm-info-" candidate))))
@@ -223,18 +223,18 @@ helm-info-<CANDIDATE>."
;;;###autoload
(defun helm-info (&optional refresh)
- "Preconfigured `helm\\=' for searching Info files\\=' indices.
+ "Preconfigured `helm' for searching Info files' indices.
With a prefix argument \\[universal-argument], set REFRESH to
non-nil.
Optional parameter REFRESH, when non-nil, re-evaluates
-`helm-default-info-index-list\\='. If the variable has been
+`helm-default-info-index-list'. If the variable has been
customized, set it to its saved value. If not, set it to its
-standard value. See `custom-reevaluate-setting\\=' for more.
+standard value. See `custom-reevaluate-setting' for more.
REFRESH is useful when new Info files are installed. If
-`helm-default-info-index-list\\=' has not been customized, the new
+`helm-default-info-index-list' has not been customized, the new
Info files are made available."
(interactive "P")
(let ((default (unless (ring-empty-p helm-info-searched)
@@ -281,7 +281,7 @@ Info files are made available."
;;;###autoload
(defun helm-info-at-point ()
- "Preconfigured `helm\\=' for searching info at point."
+ "Preconfigured `helm' for searching info at point."
(interactive)
;; Symbol at point is used as default as long as one of the sources
;; in `helm-info-default-sources' is member of
diff --git a/helm-lib.el b/helm-lib.el
index 1153b7af8a..5d98e333af 100644
--- a/helm-lib.el
+++ b/helm-lib.el
@@ -88,18 +88,18 @@ Directories expansion is not supported yet."
:type 'boolean)
(defcustom helm-yank-text-at-point-function nil
- "The function used to forward point with `helm-yank-text-at-point\\='.
-With a nil value, fallback to default `forward-word\\='.
-The function should take one arg, an integer like `forward-word\\='.
-NOTE: Using `forward-symbol\\=' here is not very useful as it is
+ "The function used to forward point with `helm-yank-text-at-point'.
+With a nil value, fallback to default `forward-word'.
+The function should take one arg, an integer like `forward-word'.
+NOTE: Using `forward-symbol' here is not very useful as it is
already provided by \\<helm-map>\\[next-history-element]."
:type 'function
:group 'helm)
(defcustom helm-scroll-amount nil
"Scroll amount when scrolling helm window or other window in a helm session.
-It is used by `helm-scroll-other-window\\=', `helm-scroll-up\\=',
`helm-scroll-down\\='
-and `helm-scroll-other-window-down\\='.
+It is used by `helm-scroll-other-window', `helm-scroll-up', `helm-scroll-down'
+and `helm-scroll-other-window-down'.
If you prefer scrolling line by line, set this value to 1."
:group 'helm
@@ -109,7 +109,7 @@ If you prefer scrolling line by line, set this value to 1."
"Display help window in full frame when non nil.
Even when nil probably the same result (full frame) can be
-reached by tweaking `display-buffer-alist\\=', but it is much more
+reached by tweaking `display-buffer-alist', but it is much more
convenient to use a simple boolean value here."
:type 'boolean
:group 'helm-help)
@@ -138,7 +138,7 @@ convenient to use a simple boolean value here."
completion-ignored-extensions)
"A list of regexps matching boring files.
-This list is build by default on `completion-ignored-extensions\\='.
+This list is build by default on `completion-ignored-extensions'.
The directory names should end with \"/?\" e.g. \"\\.git/?\" and
the file names should end with \"$\" e.g. \"\\.o$\".
@@ -147,8 +147,8 @@ file name, so for example to ignore files with a prefix
\".bak.\", use \"\\.bak\\..*$\" as the regexp.
NOTE: When modifying this, be sure to use customize interface or
-the customize functions e.g. `customize-set-variable\\=' and NOT
-`setq\\='."
+the customize functions e.g. `customize-set-variable' and NOT
+`setq'."
:group 'helm-files
:type '(repeat (choice regexp))
:set 'helm-ff--setup-boring-regex)
@@ -172,20 +172,20 @@ the customize functions e.g. `customize-set-variable\\='
and NOT
(defvar helm-buffer "*helm*"
"Buffer showing completions.")
(defvar helm-current-buffer nil
- "Current buffer when `helm\\=' is invoked.")
+ "Current buffer when `helm' is invoked.")
(defvar helm-suspend-update-flag nil)
(defvar helm-action-buffer "*helm action*"
"Buffer showing actions.")
(defvar helm-current-prefix-arg nil
- "Record `current-prefix-arg\\=' when exiting minibuffer.")
+ "Record `current-prefix-arg' when exiting minibuffer.")
;;; Compatibility
;;
(defun helm-add-face-text-properties (beg end face &optional append object)
"Add the face property to the text from START to END.
It is a compatibility function which behaves exactly like
-`add-face-text-property\\=' if available, otherwise like
-`add-text-properties\\='. When only `add-text-properties\\=' is
+`add-face-text-property' if available, otherwise like
+`add-text-properties'. When only `add-text-properties' is
available APPEND is ignored."
(if (fboundp 'add-face-text-property)
(add-face-text-property beg end face append object)
@@ -356,7 +356,7 @@ available APPEND is ignored."
nil)
(defcustom helm-advice-push-mark t
- "Override `push-mark\\=' with a version avoiding duplicates when non-nil."
+ "Override `push-mark' with a version avoiding duplicates when non-nil."
:group 'helm
:type 'boolean
:set (lambda (var val)
@@ -412,8 +412,8 @@ available APPEND is ignored."
(defun helm-this-command ()
"Return the actual command in action.
-Like `this-command\\=' but return the real command, and not
-`exit-minibuffer\\=' or other unwanted functions."
+Like `this-command' but return the real command, and not
+`exit-minibuffer' or other unwanted functions."
(cl-loop for count from 1 to 50
for btf = (backtrace-frame count)
for fn = (cl-second btf)
@@ -434,11 +434,11 @@ Like `this-command\\=' but return the real command, and
not
;;; Iterators
;;
(cl-defmacro helm-position (item seq &key test all)
- "A simple and faster replacement of CL `position\\='.
+ "A simple and faster replacement of CL `position'.
Returns ITEM first occurence position found in SEQ.
When SEQ is a string, ITEM have to be specified as a char.
-Argument TEST when unspecified default to `eq\\='.
+Argument TEST when unspecified default to `eq'.
When argument ALL is non-nil return a list of all ITEM positions
found in SEQ."
(let ((key (if (stringp seq) 'across 'in)))
@@ -482,20 +482,20 @@ found in SEQ."
;;; Anaphoric macros.
;;
(defmacro helm-aif (test-form then-form &rest else-forms)
- "Anaphoric version of `if\\='.
-Like `if\\=' but set the result of TEST-FORM in a temporary variable
-called `it\\='. THEN-FORM and ELSE-FORMS are then executed just like
-in `if\\='."
+ "Anaphoric version of `if'.
+Like `if' but set the result of TEST-FORM in a temporary variable
+called `it'. THEN-FORM and ELSE-FORMS are then executed just like
+in `if'."
(declare (indent 2) (debug t))
`(let ((it ,test-form))
(if it ,then-form ,@else-forms)))
(defmacro helm-awhile (sexp &rest body)
- "Anaphoric version of `while\\='.
-Same usage as `while\\=' except that SEXP is bound to a temporary
-variable called `it\\=' at each turn.
+ "Anaphoric version of `while'.
+Same usage as `while' except that SEXP is bound to a temporary
+variable called `it' at each turn.
An implicit nil block is bound to the loop so usage of
-`cl-return\\=' is possible to exit the loop."
+`cl-return' is possible to exit the loop."
(declare (indent 1) (debug t))
(helm-with-gensyms (flag)
`(let ((,flag t))
@@ -506,11 +506,11 @@ An implicit nil block is bound to the loop so usage of
(setq ,flag nil)))))))
(defmacro helm-acond (&rest clauses)
- "Anaphoric version of `cond\\='.
+ "Anaphoric version of `cond'.
In each clause of CLAUSES, the result of the car of clause is
-stored in a temporary variable called `it\\=' and usable in the cdr
-of this same clause. Each `it\\=' variable is independent of its
-clause. The usage is the same as `cond\\='."
+stored in a temporary variable called `it' and usable in the cdr
+of this same clause. Each `it' variable is independent of its
+clause. The usage is the same as `cond'."
(declare (debug cond))
(unless (null clauses)
(helm-with-gensyms (sym)
@@ -523,8 +523,8 @@ clause. The usage is the same as `cond\\='."
(helm-acond ,@(cdr clauses))))))))
(defmacro helm-aand (&rest conditions)
- "Anaphoric version of `and\\='.
-Each condition is bound to a temporary variable called `it\\=' which
+ "Anaphoric version of `and'.
+Each condition is bound to a temporary variable called `it' which
is usable in next condition."
(declare (debug (&rest form)))
(cond ((null conditions) t)
@@ -533,8 +533,8 @@ is usable in next condition."
(helm-aand ,@(cdr conditions))))))
(defmacro helm-acase (expr &rest clauses)
- "A simple anaphoric `cl-case\\=' implementation handling strings.
-EXPR is bound to a temporary variable called `it\\=' which is usable
+ "A simple anaphoric `cl-case' implementation handling strings.
+EXPR is bound to a temporary variable called `it' which is usable
in CLAUSES to refer to EXPR.
NOTE: Duplicate keys in CLAUSES are deliberately not handled.
@@ -590,7 +590,7 @@ E.g.: helm.el$
(defcustom helm-help-default-prompt
"[SPC,C-v,next:ScrollUp b,M-v,prior:ScrollDown TAB:Cycle M-TAB:All
C-s/r:Isearch q:Quit]"
- "The prompt used in `helm-help\\='."
+ "The prompt used in `helm-help'."
:type 'string
:group 'helm)
@@ -628,20 +628,20 @@ E.g.: helm.el$
("M-TAB" . helm-help-org-cycle)
("M-w" . helm-help-copy-region-as-kill)
("q" . helm-help-quit))
- "Alist of (KEY . FUNCTION) for `helm-help\\='.
+ "Alist of (KEY . FUNCTION) for `helm-help'.
This is not a standard keymap, just an alist where it is possible to
define a simple KEY (a string with no spaces) associated with a
FUNCTION. More complex key like \"C-x C-x\" are not supported.
Interactive functions will be called interactively whereas other
functions will be called with funcall except commands that are in
-`helm-help-not-interactive-command\\='.
-For convenience you can add bindings here with `helm-help-define-key\\='."
+`helm-help-not-interactive-command'.
+For convenience you can add bindings here with `helm-help-define-key'."
:type '(alist :key-type string :key-value symbol)
:group 'helm)
(defvar helm-help-not-interactive-command '(isearch-forward isearch-backward)
- "Commands that we don\\='t want to call interactively in `helm-help\\='.")
+ "Commands that we don't want to call interactively in `helm-help'.")
(defun helm-help-internal (bufname insert-content-fn)
"Show long message during Helm session in BUFNAME.
@@ -676,67 +676,67 @@ displayed in BUFNAME."
(set-frame-configuration winconf)))))
(cl-defun helm-help-scroll-up (&optional (amount helm-scroll-amount))
- "Scroll up in `helm-help\\='."
+ "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\\='."
+ "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\\='."
+ "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\\='."
+ "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\\='."
+ "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\\='."
+ "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 function for `helm-help'"
(copy-region-as-kill
(region-beginning) (region-end))
(deactivate-mark))
(defun helm-help-quit ()
- "Quit `helm-help\\='."
+ "Quit `helm-help'."
(throw 'helm-help-quit nil))
(defun helm-help-org-open-at-point ()
- "Calls `org-open-at-point\\=' ignoring errors."
+ "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."
+ "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\\='."
+ "The loop in charge of scanning keybindings in `helm-help'."
(let ((prompt (propertize
helm-help-default-prompt
'face 'helm-helper))
@@ -757,13 +757,13 @@ displayed in BUFNAME."
(funcall fun))))))))
(defun helm-help-define-key (key function &optional override)
- "Add KEY bound to fUNCTION in `helm-help-hkmap\\='.
+ "Add KEY bound to fUNCTION in `helm-help-hkmap'.
If OVERRIDE is non nil, all bindings associated with FUNCTION are
removed and only (KEY . FUNCTION) is kept.
If FUNCTION is nil (KEY . FUNCTION) is not added and removed from
alist if already present.
-See `helm-help-hkmap\\=' for supported keys and functions."
+See `helm-help-hkmap' for supported keys and functions."
(cl-assert (not (cdr (split-string key))) nil
(format "Error: Unsuported key `%s'" key))
(when override
@@ -811,7 +811,7 @@ See `helm-help-hkmap\\=' for supported keys and functions."
"Return a list of all single elements of sublists in SEQ.
Example:
- (helm-flatten-list \\='(1 (2 . 3) nil (4 5 (6) 7) 8 (9 . 10)))
+ (helm-flatten-list '(1 (2 . 3) nil (4 5 (6) 7) 8 (9 . 10)))
=> (1 2 3 4 5 6 7 8 9 10)"
(let (result)
(cl-labels ((flatten
@@ -827,7 +827,7 @@ See `helm-help-hkmap\\=' for supported keys and functions."
(nreverse result)))
(defun helm-mklist (obj)
- "If OBJ is a list (but not lambda), return itself.
+ "If OBJ is a list \(but not lambda\), return itself.
Otherwise make a list with one element."
(if (and (listp obj) (not (functionp obj)))
obj
@@ -836,14 +836,14 @@ Otherwise make a list with one element."
(cl-defun helm-fast-remove-dups (seq &key (test 'eq))
"Remove duplicates elements in list SEQ.
-This is same as `remove-duplicates\\=' but with memoisation.
+This is same as `remove-duplicates' but with memoisation.
It is much faster, especially in large lists.
A test function can be provided with TEST argument key.
-Default is `eq\\='.
+Default is `eq'.
NOTE: Comparison of special Elisp objects (e.g., markers etc.)
fails because their printed representations which are stored in
-hash-table can\\='t be compared with with the real object in SEQ.
-This is a bug in `puthash\\=' which store the printable
+hash-table can't be compared with with the real object in SEQ.
+This is a bug in `puthash' which store the printable
representation of object instead of storing the object itself,
this to provide at the end a printable representation of
hashtable itself."
@@ -898,7 +898,7 @@ hashtable itself."
else collect i)))
(defun helm-remove-if-not-match (regexp seq)
- "Remove all elements of SEQ that don\\='t match REGEXP."
+ "Remove all elements of SEQ that don't match REGEXP."
(cl-loop for s in seq
for str = (cond ((symbolp s)
(symbol-name s))
@@ -920,13 +920,13 @@ hashtable itself."
collect s))
(defun helm-transform-mapcar (function args)
- "`mapcar\\=' for candidate-transformer.
+ "`mapcar' for candidate-transformer.
ARGS is (cand1 cand2 ...) or ((disp1 . real1) (disp2 . real2) ...)
-\(helm-transform-mapcar \\='upcase \\='(\"foo\" \"bar\"))
+\(helm-transform-mapcar 'upcase '(\"foo\" \"bar\"))
=> (\"FOO\" \"BAR\")
-\(helm-transform-mapcar \\='upcase \\='((\"1st\" . \"foo\") (\"2nd\" .
\"bar\")))
+\(helm-transform-mapcar 'upcase '((\"1st\" . \"foo\") (\"2nd\" . \"bar\")))
=> ((\"1st\" . \"FOO\") (\"2nd\" . \"BAR\"))
"
(cl-loop for arg in args
@@ -956,14 +956,14 @@ If ELM is not a list transform it in list."
(defun helm-take-first-elements (seq n)
"Return the first N elements of SEQ if SEQ is longer than N.
It is used for narrowing list of candidates to the
-`helm-candidate-number-limit\\='."
+`helm-candidate-number-limit'."
(if (> (length seq) n) (cl-subseq seq 0 n) seq))
(defun helm-source-by-name (name &optional sources)
"Get a Helm source in SOURCES by NAME.
Optional argument SOURCES is a list of Helm sources which default
-to `helm-sources\\='."
+to `helm-sources'."
(cl-loop with src-list = (if sources
(cl-loop for src in sources
collect (if (listp src)
@@ -1001,9 +1001,9 @@ Items not matching FUNCTION are grouped as well in a
separate group.
Example:
- (setq B \\='(1 2 3 4 5 6 7 8 9))
+ (setq B '(1 2 3 4 5 6 7 8 9))
- (helm-group-candidates-by B #\\='cl-oddp 2 \\='separate)
+ (helm-group-candidates-by B #'cl-oddp 2 'separate)
=> ((2 4 6 8) (1 3 5 7 9))
SELECTION specify where to start in CANDIDATES.
@@ -1029,9 +1029,9 @@ otherwise a plain list is returned."
Examples:
- (helm-reorganize-sequence-from-elm \\='(a b c d e f g h i j k l) \\='e)
+ (helm-reorganize-sequence-from-elm '(a b c d e f g h i j k l) 'e)
=> (f g h i j k l a b c d e)
- (helm-reorganize-sequence-from-elm \\='(a b c d e f g h i j k l) \\='e t)
+ (helm-reorganize-sequence-from-elm '(a b c d e f g h i j k l) 'e t)
=> (d c b a l k j i h g f e)
"
(let* ((new-seq (if reverse
@@ -1061,7 +1061,7 @@ Handle multibyte characters by moving by columns."
(defun helm-substring-by-width (str width &optional endstr)
"Truncate string STR to end at column WIDTH.
-Similar to `truncate-string-to-width\\='.
+Similar to `truncate-string-to-width'.
Add ENDSTR at end of truncated STR.
Add spaces at end if needed to reach WIDTH when STR is shorter
than WIDTH."
@@ -1113,21 +1113,21 @@ than WIDTH."
(defun helm--replace-regexp-in-buffer-string (regexp rep str &optional
fixedcase literal subexp start)
"Replace REGEXP by REP in string STR.
-Same as `replace-regexp-in-string\\=' but handle properly REP as
+Same as `replace-regexp-in-string' but handle properly REP as
function with SUBEXP specified.
E.g.:
(helm--replace-regexp-in-buffer-string
- \"e\\\\(m\\\\)acs\" \\='upcase \"emacs\" t nil 1)
+ \"e\\\\(m\\\\)acs\" 'upcase \"emacs\" t nil 1)
=> \"eMacs\"
(replace-regexp-in-string
- \"e\\\\(m\\\\)acs\" \\='upcase \"emacs\" t nil 1)
+ \"e\\\\(m\\\\)acs\" 'upcase \"emacs\" t nil 1)
=> \"eEMACSacs\"
Also START argument behaves as expected unlike
-`replace-regexp-in-string\\='.
+`replace-regexp-in-string'.
E.g.:
@@ -1137,14 +1137,14 @@ E.g.:
(replace-regexp-in-string \"f\" \"r\" \"foofoo\" t nil nil 3)
=> \"roo\"
-Unlike `replace-regexp-in-string\\=' this function is buffer-based
+Unlike `replace-regexp-in-string' this function is buffer-based
implemented i.e. replacement is computed inside a temp buffer, so
REGEXP should be used differently than with
-`replace-regexp-in-string\\='.
+`replace-regexp-in-string'.
NOTE: This function is used internally for
-`helm-ff-query-replace-on-filenames\\=' and builded for this.
-You should use `replace-regexp-in-string\\=' instead unless the
+`helm-ff-query-replace-on-filenames' and builded for this.
+You should use `replace-regexp-in-string' instead unless the
behaviour of this function is really needed."
(with-temp-buffer
(insert str)
@@ -1159,7 +1159,7 @@ behaviour of this function is really needed."
(buffer-string)))
(defun helm-url-unhex-string (str)
- "Same as `url-unhex-string\\=' but ensure STR is completely decoded."
+ "Same as `url-unhex-string' but ensure STR is completely decoded."
(setq str (or str ""))
(with-temp-buffer
(save-excursion (insert str))
@@ -1185,7 +1185,7 @@ Example:
(let ((answer (helm-read-answer
\"answer [y,n,!,q]: \"
- \\='(\"y\" \"n\" \"!\" \"q\"))))
+ '(\"y\" \"n\" \"!\" \"q\"))))
(pcase answer
(\"y\" \"yes\")
(\"n\" \"no\")
@@ -1247,7 +1247,7 @@ Example:
Argument NAME is used internally to know which command to use
when symbol CANDIDATE refers at the same time to a variable and a
function.
-See `helm-elisp-show-help\\='."
+See `helm-elisp-show-help'."
(let ((hbuf (get-buffer (help-buffer))))
(cond ((helm-follow-mode-p)
(if name
@@ -1282,13 +1282,13 @@ See `helm-elisp-show-help\\='."
(helm-set-attr 'help-current-symbol candidate)))
(defcustom helm-find-function-default-project nil
- "Default directories to search symbols definitions from `helm-apropos\\='.
+ "Default directories to search symbols definitions from `helm-apropos'.
A list of directories or a single directory name.
-Helm will allow you selecting one of those directories with `M-n\\=' when
-using a prefix arg with the `find-function\\=' action in `helm-apropos\\='.
+Helm will allow you selecting one of those directories with `M-n' when
+using a prefix arg with the `find-function' action in `helm-apropos'.
This is a good idea to add the directory names of the projects you are
working on to quickly jump to the definitions in the project source
-files instead of jumping to the loaded files located in `load-path\\='."
+files instead of jumping to the loaded files located in `load-path'."
:type '(choice (repeat string)
string)
:group 'helm-elisp)
@@ -1300,7 +1300,7 @@ Instead of looking in LOAD-PATH to find library, this
function
search in all subdirs of ROOT-DIR, if ROOT-DIR is unspecified ask for
it with completion.
TYPE when nil specify function, for other values see
-`find-function-regexp-alist\\='."
+`find-function-regexp-alist'."
(require 'find-func)
(let* ((sym (helm-symbolify func))
(dir (or root-dir (helm-read-file-name
@@ -1353,7 +1353,7 @@ using LOAD-PATH."
(defun helm-kill-new (candidate &optional replace)
"CANDIDATE is symbol or string.
-See `kill-new\\=' for argument REPLACE."
+See `kill-new' for argument REPLACE."
(kill-new (helm-stringify candidate) replace))
@@ -1401,7 +1401,7 @@ Argument ALIST is an alist of associated major modes."
;;; Files routines
;;
(defun helm-file-name-sans-extension (filename)
- "Same as `file-name-sans-extension\\=' but remove all extensions."
+ "Same as `file-name-sans-extension' but remove all extensions."
(helm-aif (file-name-sans-extension filename)
;; Start searching at index 1 for files beginning with a dot
;; (bug#1335).
@@ -1420,9 +1420,9 @@ Argument ALIST is an alist of associated major modes."
"Print FNAME with any leading directory components removed.
If specified, also remove filename extension EXT.
Arg EXT can be specified as a string with or without dot, in this
-case it should match `file-name-extension\\='.
+case it should match `file-name-extension'.
It can also be non-nil (t) in this case no checking of
-`file-name-extension\\=' is done and the extension is removed
+`file-name-extension' is done and the extension is removed
unconditionally."
(let ((non-essential t))
(if (and ext (or (string= (file-name-extension fname) ext)
@@ -1448,12 +1448,12 @@ Useful in dired buffers when there is inserted subdirs."
default-directory)))
(defun helm-shadow-boring-files (files)
- "Files matching `helm-boring-file-regexp\\=' will be
-displayed with the `file-name-shadow\\=' face if available."
+ "Files matching `helm-boring-file-regexp' will be
+displayed with the `file-name-shadow' face if available."
(helm-shadow-entries files helm-boring-file-regexp-list))
(defun helm-skip-boring-files (files)
- "Files matching `helm-boring-file-regexp\\=' will be skipped."
+ "Files matching `helm-boring-file-regexp' will be skipped."
(helm-skip-entries files helm-boring-file-regexp-list))
(defun helm-skip-current-file (files)
@@ -1506,15 +1506,15 @@ Argument PATH can be one of basename, relative, full,
or a
function called on file name, default to basename.
Argument DIRECTORIES when t return also directories names,
-otherwise skip directories names, with a value of `only\\=' returns
+otherwise skip directories names, with a value of `only' returns
only subdirectories, i.e. files are skipped.
Argument MATCH is a regexp matching files or directories.
Argument SKIP-SUBDIRS when t will skip
-`helm-walk-ignore-directories\\=', otherwise if it is given as a
+`helm-walk-ignore-directories', otherwise if it is given as a
list of directories, this list will be used instead of
-`helm-walk-ignore-directories\\='.
+`helm-walk-ignore-directories'.
Argument NOERROR when t will skip directories which are not
accessible."
@@ -1554,7 +1554,7 @@ accessible."
(ls-rec directory))))
(defun helm-file-expand-wildcards (pattern &optional full)
- "Same as `file-expand-wildcards\\=' but allow recursion.
+ "Same as `file-expand-wildcards' but allow recursion.
Recursion happens when PATTERN starts with two stars.
Directories expansion is not supported."
(let ((bn (helm-basename pattern))
@@ -1604,13 +1604,13 @@ That is what completion commands operate on."
(buffer-substring (field-beginning) (point)))
(defmacro with-helm-buffer (&rest body)
- "Eval BODY inside `helm-buffer\\='."
+ "Eval BODY inside `helm-buffer'."
(declare (indent 0) (debug t))
`(with-current-buffer (helm-buffer-get)
,@body))
(defmacro with-helm-current-buffer (&rest body)
- "Eval BODY inside `helm-current-buffer\\='."
+ "Eval BODY inside `helm-current-buffer'."
(declare (indent 0) (debug t))
`(with-current-buffer (or (and (buffer-live-p helm-current-buffer)
helm-current-buffer)
@@ -1619,17 +1619,17 @@ That is what completion commands operate on."
,@body))
(defun helm-buffer-get ()
- "Return `helm-action-buffer\\=' if shown otherwise `helm-buffer\\='."
+ "Return `helm-action-buffer' if shown otherwise `helm-buffer'."
(if (helm-action-window)
helm-action-buffer
helm-buffer))
(defun helm-window ()
- "Window of `helm-buffer\\='."
+ "Window of `helm-buffer'."
(get-buffer-window (helm-buffer-get) 0))
(defun helm-action-window ()
- "Window of `helm-action-buffer\\='."
+ "Window of `helm-action-buffer'."
(get-buffer-window helm-action-buffer 'visible))
(defmacro with-helm-window (&rest body)
@@ -1640,7 +1640,7 @@ That is what completion commands operate on."
(defmacro helm-without-follow (&rest body)
"Ensure BODY runs without following.
-I.e. when using `helm-next-line\\=' and friends in BODY."
+I.e. when using `helm-next-line' and friends in BODY."
(declare (indent 0) (debug t))
`(cl-letf (((symbol-function 'helm-follow-mode-p)
(lambda (&optional _) nil)))
@@ -1665,18 +1665,18 @@ I.e. when using `helm-next-line\\=' and friends in
BODY."
(defvar helm-blacklist-completion-styles '(emacs21 emacs22))
(defun helm--prepare-completion-styles (&optional nomode styles)
- "Return a suitable list of styles for `completion-styles\\='.
+ "Return a suitable list of styles for `completion-styles'.
-When `helm-completion-style\\=' is not `emacs\\=' the Emacs vanilla
-default `completion-styles\\=' is used except for
-`helm-dynamic-completion\\=' which uses inconditionally `emacs\\=' as
-value for `helm-completion-style\\='.
+When `helm-completion-style' is not `emacs' the Emacs vanilla
+default `completion-styles' is used except for
+`helm-dynamic-completion' which uses inconditionally `emacs' as
+value for `helm-completion-style'.
-If styles are specified in `helm-completion-styles-alist\\=' for a
+If styles are specified in `helm-completion-styles-alist' for a
particular mode, use these styles unless NOMODE is non nil.
If STYLES is specified as a list of styles suitable for
-`completion-styles\\=' these styles are used in the given order.
-Otherwise helm style is added to `completion-styles\\=' always after
+`completion-styles' these styles are used in the given order.
+Otherwise helm style is added to `completion-styles' always after
flex or helm-flex completion style if present."
;; For `helm-completion-style' and `helm-completion-styles-alist'.
(require 'helm-mode)
@@ -1707,12 +1707,12 @@ flex or helm-flex completion style if present."
1 0))))))
(defun helm-dynamic-completion (collection predicate &optional point metadata
nomode styles)
- "Build a completion function for `helm-pattern\\=' in COLLECTION.
+ "Build a completion function for `helm-pattern' in COLLECTION.
Only the elements of COLLECTION that satisfy PREDICATE are considered.
-Argument POINT is the same as in `completion-all-completions\\=' and
-is meaningful only when using some kind of `completion-at-point\\='.
+Argument POINT is the same as in `completion-all-completions' and
+is meaningful only when using some kind of `completion-at-point'.
The return value is a list of completions that may be sorted by
the sort function provided by the completion-style in
@@ -1721,26 +1721,26 @@ to be provided if needed either with an FCT function in
source or
by passing the sort function with METADATA
E.g.: (metadata (display-sort-function . foo)).
-If you don\\='t want the sort fn provided by style to kick
-in (emacs-27) you can use as metadata value the symbol `nosort\\='.
+If you don't want the sort fn provided by style to kick
+in (emacs-27) you can use as metadata value the symbol `nosort'.
Example:
(helm :sources (helm-build-sync-source \"test\"
:candidates (helm-dynamic-completion
- \\='(foo bar baz foab)
- \\='symbolp)
+ '(foo bar baz foab)
+ 'symbolp)
:match-dynamic t)
:buffer \"*helm test*\")
-When argument NOMODE is non nil don\\='t use `completion-styles\\=' as
-specified in `helm-completion-styles-alist\\=' for specific modes.
+When argument NOMODE is non nil don't use `completion-styles' as
+specified in `helm-completion-styles-alist' for specific modes.
-When STYLES is specified use these `completion-styles\\=', see
-`helm--prepare-completion-styles\\='.
+When STYLES is specified use these `completion-styles', see
+`helm--prepare-completion-styles'.
-Also `helm-completion-style\\=' settings have no effect here,
-`emacs\\=' being used inconditionally as value."
+Also `helm-completion-style' settings have no effect here,
+`emacs' being used inconditionally as value."
(lambda ()
(let* (;; Force usage of emacs style otherwise
;; helm--prepare-completion-styles will reset
@@ -1781,7 +1781,7 @@ Also `helm-completion-style\\=' settings have no effect
here,
;;
;;
(defun helm-yank-text-at-point (arg)
- "Yank text at point in `helm-current-buffer\\=' into minibuffer."
+ "Yank text at point in `helm-current-buffer' into minibuffer."
(interactive "p")
(with-helm-current-buffer
(let ((fwd-fn (or helm-yank-text-at-point-function #'forward-word))
@@ -1813,7 +1813,7 @@ Also `helm-completion-style\\=' settings have no effect
here,
(put 'helm-yank-text-at-point 'helm-only t)
(defun helm-undo-yank-text-at-point ()
- "Undo last entry added by `helm-yank-text-at-point\\='."
+ "Undo last entry added by `helm-yank-text-at-point'."
(interactive)
(helm-yank-text-at-point -1))
(put 'helm-undo-yank-text-at-point 'helm-only t)
@@ -1832,16 +1832,16 @@ Also `helm-completion-style\\=' settings have no effect
here,
(defvar helm--ansi-color-drop-regexp
"\033\\[\\([ABCDsuK]\\|[12][JK]\\|=[0-9]+[hI]\\|[0-9;]*[Hf]\\)")
(defun helm--ansi-color-apply (string)
- "A version of `ansi-color-apply\\=' immune to upstream changes.
+ "A version of `ansi-color-apply' immune to upstream changes.
Similar to the emacs-24.5 version without support to
-`ansi-color-context\\=' which is buggy in Emacs.
+`ansi-color-context' which is buggy in Emacs.
-Modify also `ansi-color-regexp\\=' by using own variable
-`helm--ansi-color-regexp\\=' that matches whole STRING.
+Modify also `ansi-color-regexp' by using own variable
+`helm--ansi-color-regexp' that matches whole STRING.
This is needed to provide compatibility for both emacs-25 and
-emacs-24.5 as emacs-25 version of `ansi-color-apply\\=' is partially
+emacs-24.5 as emacs-25 version of `ansi-color-apply' is partially
broken."
(require 'ansi-color)
(let ((start 0)
diff --git a/helm-locate.el b/helm-locate.el
index a1fb868985..534df279ed 100644
--- a/helm-locate.el
+++ b/helm-locate.el
@@ -54,7 +54,7 @@ arg."
"A list of arguments for locate program.
Helm will calculate a default value for your system on startup
-unless `helm-locate-command\\=' is non-nil.
+unless `helm-locate-command' is non-nil.
Here are the default values it will use according to your system:
@@ -63,9 +63,9 @@ berkeley-unix: \"locate %s %s\"
windows-nt: \"es %s %s\"
Others: \"locate %s %s\"
-This string will be passed to format so it should end with `%s\\='.
+This string will be passed to format so it should end with `%s'.
The first format spec is used for the \"-i\" value of locate/es,
-so don\\='t set it directly but use `helm-locate-case-fold-search\\='
+so don't set it directly but use `helm-locate-case-fold-search'
for this.
The last option must be the one preceding pattern i.e \"-r\" or
@@ -76,7 +76,7 @@ during Helm invocation after entering pattern only when multi
matching, not when fuzzy matching.
Note that the \"-b\" option is added automatically by Helm when
-var `helm-locate-fuzzy-match\\=' is non-nil and switching back from
+var `helm-locate-fuzzy-match' is non-nil and switching back from
multimatch to fuzzy matching (this is done automatically when a
space is detected in pattern)."
:type 'string
@@ -89,9 +89,9 @@ space is detected in pattern)."
:group 'helm-locate)
(defcustom helm-locate-case-fold-search helm-case-fold-search
- "It have the same meaning as `helm-case-fold-search\\='.
+ "It have the same meaning as `helm-case-fold-search'.
The -i option of locate will be used depending of value of
-`helm-pattern\\=' when this is set to \\='smart.
+`helm-pattern' when this is set to 'smart.
When nil \"-i\" will not be used at all and when non-nil it will
always be used.
NOTE: the -i option of the \"es\" command used on windows does
@@ -100,7 +100,7 @@ the opposite of \"locate\" command."
:type 'symbol)
(defcustom helm-locate-fuzzy-match nil
- "Enable fuzzy matching in `helm-locate\\='.
+ "Enable fuzzy matching in `helm-locate'.
Note that when this is enabled searching is done on basename."
:group 'helm-locate
:type 'boolean)
@@ -114,20 +114,20 @@ Note that when this is enabled searching is done on
basename."
(defcustom helm-locate-project-list nil
"A list of directories, your projects.
When set, allow browsing recursively files in all directories of
-this list with `helm-projects-find-files\\='."
+this list with `helm-projects-find-files'."
:group 'helm-locate
:type '(repeat string))
(defcustom helm-locate-recursive-dirs-command "locate -i -e -A --regex '^%s'
'%s.*$'"
- "Command used for recursive directories completion in `helm-find-files\\='.
+ "Command used for recursive directories completion in `helm-find-files'.
-For Windows and `es\\=' use something like \"es -r ^%s.*%s.*$\"
+For Windows and `es' use something like \"es -r ^%s.*%s.*$\"
The two format specs are mandatory.
-If for some reasons you can\\='t use locate because your filesystem
-doesn\\='t have a database, you can use find command from findutils
-but be aware that it will be much slower. See `helm-find-files\\='
+If for some reasons you can't use locate because your filesystem
+doesn't have a database, you can use find command from findutils
+but be aware that it will be much slower. See `helm-find-files'
embedded help for more infos."
:type 'string
:group 'helm-files)
@@ -148,8 +148,8 @@ embedded help for more infos."
(defun helm-ff-find-locatedb (&optional from-ff)
"Try to find if a local locatedb file is available.
-The search is done in `helm-ff-default-directory\\=' or falls back to
-`default-directory\\=' if FROM-FF is nil."
+The search is done in `helm-ff-default-directory' or falls back to
+`default-directory' if FROM-FF is nil."
(helm-aif (and helm-ff-locate-db-filename
(locate-dominating-file
(or (and from-ff
@@ -169,16 +169,16 @@ Argument DIRECTORY root of file system subtree to scan."
#'helm-locate-create-db-default-function
"Function used to create a locale locate db file.
It should receive the same arguments as
-`helm-locate-create-db-default-function\\='.")
+`helm-locate-create-db-default-function'.")
(defun helm-locate-1 (&optional localdb init from-ff default)
"Generic function to run Locate.
Prefix arg LOCALDB when (4) search and use a local locate db file
when it exists or create it, when (16) force update of existing
db file even if exists.
-It has no effect when locate command is \\='es\\='. INIT is a string
+It has no effect when locate command is 'es'. INIT is a string
to use as initial input in prompt.
-See `helm-locate-with-db\\=' and `helm-locate\\='."
+See `helm-locate-with-db' and `helm-locate'."
(require 'helm-mode)
(helm-locate-set-command)
(let ((pfn (lambda (candidate)
@@ -215,7 +215,7 @@ See `helm-locate-with-db\\=' and `helm-locate\\='."
(helm-locate-with-db (and localdb locdb) init default)))
(defun helm-locate-set-command ()
- "Setup `helm-locate-command\\=' if not already defined."
+ "Setup `helm-locate-command' if not already defined."
(unless helm-locate-command
(setq helm-locate-command
(cl-case system-type
@@ -234,7 +234,7 @@ See `helm-locate-with-db\\=' and `helm-locate\\='."
If DB is not given or nil use locate without -d option.
Argument DB can be given as a string or list of db files.
Argument INITIAL-INPUT is a string to use as initial-input.
-See also `helm-locate\\='."
+See also `helm-locate'."
(require 'helm-files)
(when (and db (stringp db)) (setq db (list db)))
(helm-locate-set-command)
@@ -285,7 +285,7 @@ See also `helm-locate\\='."
(force-mode-line-update)))
(defun helm-locate-init ()
- "Initialize async locate process for `helm-source-locate\\='."
+ "Initialize async locate process for `helm-source-locate'."
(let* ((locate-is-es (string-match "\\`es" helm-locate-command))
(real-locate (string-match "\\`locate" helm-locate-command))
(case-sensitive-flag (if locate-is-es "-i" ""))
@@ -435,7 +435,7 @@ Sort is done on basename of CANDIDATES."
;;;###autoload
(defun helm-projects-find-files (update)
- "Find files with locate in `helm-locate-project-list\\='.
+ "Find files with locate in `helm-locate-project-list'.
With a prefix arg refresh the database in each project."
(interactive "P")
(helm-locate-set-command)
@@ -449,18 +449,18 @@ With a prefix arg refresh the database in each project."
;;;###autoload
(defun helm-locate (arg)
- "Preconfigured `helm\\=' for Locate.
+ "Preconfigured `helm' for Locate.
Note: you can add locate options after entering pattern.
-See \\='man locate\\=' for valid options and also `helm-locate-command\\='.
+See 'man locate' for valid options and also `helm-locate-command'.
You can specify a local database with prefix argument ARG.
With two prefix arg, refresh the current local db or create it if
-it doesn\\='t exists.
+it doesn't exists.
To create a user specific db, use
\"updatedb -l 0 -o db_path -U directory\".
Where db_path is a filename matched by
-`helm-locate-db-file-regexp\\='."
+`helm-locate-db-file-regexp'."
(interactive "P")
(helm-set-local-variable 'helm-async-outer-limit-hook
(list (lambda ()
diff --git a/helm-man.el b/helm-man.el
index 4a059c4836..010b06daee 100644
--- a/helm-man.el
+++ b/helm-man.el
@@ -47,8 +47,8 @@
(defcustom helm-man-format-switches (cl-case system-type
((darwin macos) "%s")
(t "-l %s"))
- "Arguments to pass to the `manual-entry\\=' function.
-Arguments are passed to `manual-entry\\=' with `format.\\='"
+ "Arguments to pass to the `manual-entry' function.
+Arguments are passed to `manual-entry' with `format.'"
:group 'helm-man
:type 'string)
@@ -102,7 +102,7 @@ source.")
;;;###autoload
(defun helm-man-woman (arg)
- "Preconfigured `helm\\=' for Man and Woman pages.
+ "Preconfigured `helm' for Man and Woman pages.
With a prefix arg reinitialize the cache."
(interactive "P")
(when arg (setq helm-man--pages nil))
diff --git a/helm-misc.el b/helm-misc.el
index 8ff2d0db21..5686aa046c 100644
--- a/helm-misc.el
+++ b/helm-misc.el
@@ -48,13 +48,13 @@
(defface helm-time-zone-current
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "green"))
- "Face used to colorize current time in `helm-world-time\\='."
+ "Face used to colorize current time in `helm-world-time'."
:group 'helm-misc)
(defface helm-time-zone-home
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:foreground "red"))
- "Face used to colorize home time in `helm-world-time\\='."
+ "Face used to colorize home time in `helm-world-time'."
:group 'helm-misc)
@@ -176,8 +176,8 @@
;;
(defun helm-call-interactively (cmd-or-name)
"Execute CMD-OR-NAME as Emacs command.
-It is added to `extended-command-history\\='.
-`helm-current-prefix-arg\\=' is used as the command\\='s prefix argument."
+It is added to `extended-command-history'.
+`helm-current-prefix-arg' is used as the command's prefix argument."
(setq extended-command-history
(cons (helm-stringify cmd-or-name)
(delete (helm-stringify cmd-or-name) extended-command-history)))
@@ -198,7 +198,7 @@ It is added to `extended-command-history\\='.
map))
(defcustom helm-minibuffer-history-must-match t
- "Allow inserting non matching elements when nil or \\='confirm."
+ "Allow inserting non matching elements when nil or 'confirm."
:group 'helm-misc
:type '(choice
(const :tag "Must match" t)
@@ -206,7 +206,7 @@ It is added to `extended-command-history\\='.
(const :tag "Always allow" nil)))
(defcustom helm-minibuffer-history-key "C-r"
- "The key `helm-minibuffer-history\\=' is bound to in minibuffer local maps."
+ "The key `helm-minibuffer-history' is bound to in minibuffer local maps."
:type '(choice (string :tag "Key") (const :tag "no binding"))
:group 'helm-mode)
@@ -224,8 +224,8 @@ It is added to `extended-command-history\\='.
;;;###autoload
(define-minor-mode helm-minibuffer-history-mode
- "Bind `helm-minibuffer-history-key\\=' in al minibuffer maps.
-This mode is enabled by `helm-mode\\=', so there is no need to enable it
directly."
+ "Bind `helm-minibuffer-history-key' in al minibuffer maps.
+This mode is enabled by `helm-mode', so there is no need to enable it
directly."
:group 'helm-misc
:global t
(if helm-minibuffer-history-mode
@@ -326,7 +326,7 @@ This mode is enabled by `helm-mode\\=', so there is no need
to enable it directl
;;;###autoload
(defun helm-world-time ()
- "Preconfigured `helm\\=' to show world time.
+ "Preconfigured `helm' to show world time.
Default action change TZ environment variable locally to emacs."
(interactive)
(helm-other-buffer 'helm-source-time-world "*helm world time*"))
@@ -339,7 +339,7 @@ Default action change TZ environment variable locally to
emacs."
;;;###autoload
(defun helm-ratpoison-commands ()
- "Preconfigured `helm\\=' to execute ratpoison commands."
+ "Preconfigured `helm' to execute ratpoison commands."
(interactive)
(helm-other-buffer 'helm-source-ratpoison-commands
"*helm ratpoison commands*"))
@@ -353,7 +353,7 @@ Default action change TZ environment variable locally to
emacs."
;;;###autoload
(defun helm-minibuffer-history ()
- "Preconfigured `helm\\=' for `minibuffer-history\\='."
+ "Preconfigured `helm' for `minibuffer-history'."
(interactive)
(cl-assert (minibuffer-window-active-p (selected-window)) nil
"Error: Attempt to use minibuffer history outside a minibuffer")
diff --git a/helm-mode.el b/helm-mode.el
index dda9cb4b4b..a6e5377e8e 100644
--- a/helm-mode.el
+++ b/helm-mode.el
@@ -59,49 +59,49 @@
(write-region . (default helm-read-file-name-handler-1)))
"Completing read functions for specific Emacs commands.
-By default `helm-mode\\=' use `helm-completing-read-default-handler\\=' to
-provide helm completion in each `completing-read\\=' or `read-file-name\\='
+By default `helm-mode' use `helm-completing-read-default-handler' to
+provide helm completion in each `completing-read' or `read-file-name'
found, but other functions can be specified here for specific
commands. This also allows disabling helm completion for some commands
when needed.
Each entry is a cons cell like (EMACS_COMMAND . COMPLETING-READ_HANDLER)
where key and value are symbols.
-However if a command is using in its definition both a `completing-read\\=' AND
-a `read-file-name\\=' we may want to specify a handler for both of them,
+However if a command is using in its definition both a `completing-read' AND
+a `read-file-name' we may want to specify a handler for both of them,
this can be done by specifying value as a list of two symbols instead of
a single symbol where the 1st element of the list specify the handler for the
-`completing-read\\=' and the second the handler for the `read-file-name\\='.
-Special symbol \\='default\\=' means use the default helm handler for either
-`completing-read\\=' or `read-file-name\\='.
+`completing-read' and the second the handler for the `read-file-name'.
+Special symbol 'default' means use the default helm handler for either
+`completing-read' or `read-file-name'.
e.g. (write-region . (default helm-read-file-name-handler-1))
-means helm will use `helm-completing-read-default-handler\\=' when
-`write-region\\=' calls `completing-read\\=' and
-`helm-read-file-name-handler-1\\=' when it calls `read-file-name\\='.
+means helm will use `helm-completing-read-default-handler' when
+`write-region' calls `completing-read' and
+`helm-read-file-name-handler-1' when it calls `read-file-name'.
-Each key is an Emacs command that use originaly `completing-read\\='
-or/and `read-file-name\\='.
+Each key is an Emacs command that use originaly `completing-read'
+or/and `read-file-name'.
Each value maybe a helm function that takes same arguments as
-`completing-read\\=' plus NAME and BUFFER, where NAME is the name of the new
+`completing-read' plus NAME and BUFFER, where NAME is the name of the new
helm source and BUFFER the name of the buffer we will use, but it can
be also a function not using helm, in this case the function should
-take the same args as `completing-read\\=' and not be prefixed by \"helm-\".
+take the same args as `completing-read' and not be prefixed by \"helm-\".
-`helm\\=' will use the name of the command calling `completing-read\\=' as
+`helm' will use the name of the command calling `completing-read' as
NAME and BUFFER will be computed as well with NAME but prefixed with
\"*helm-mode-\".
This function prefix name must start by \"helm-\" when it uses helm,
-otherwise `helm\\=' assumes the function is not a helm function and
-expects the same args as `completing-read\\=', this allows you to define a
+otherwise `helm' assumes the function is not a helm function and
+expects the same args as `completing-read', this allows you to define a
handler not using helm completion.
Example:
(defun foo/test ()
(interactive)
- (message \"%S\" (completing-read \"test: \" \\='(a b c d e))))
+ (message \"%S\" (completing-read \"test: \" '(a b c d e))))
(defun helm-foo/test-completing-read-handler (prompt collection
predicate require-match
@@ -112,31 +112,31 @@ Example:
:name name
:buffer buffer))
- (add-to-list \\='helm-completing-read-handlers-alist
- \\='(foo/test . helm-foo/test-completing-read-handler))
+ (add-to-list 'helm-completing-read-handlers-alist
+ '(foo/test . helm-foo/test-completing-read-handler))
-We want here to make the regular `completing-read\\=' in `foo/test\\='
+We want here to make the regular `completing-read' in `foo/test'
return a list of candidate(s) instead of a single candidate.
-Note that this function will be reused for ALL the `completing-read\\='
+Note that this function will be reused for ALL the `completing-read'
of this command, so it should handle all cases. E.g.,
-if first `completing-read\\=' completes against symbols and
-second `completing-read\\=' should handle only buffer,
+if first `completing-read' completes against symbols and
+second `completing-read' should handle only buffer,
your specialized function should handle both.
If the value of an entry is nil completion will fall back to
Emacs vanilla behaviour.
Example:
-If you want to disable helm completion for `describe-function\\=', use:
+If you want to disable helm completion for `describe-function', use:
(describe-function . nil)
-Ido is also supported, you can use `ido-completing-read\\=' and
-`ido-read-file-name\\=' as value of an entry or just \\='ido.
+Ido is also supported, you can use `ido-completing-read' and
+`ido-read-file-name' as value of an entry or just 'ido.
Example:
-Enable ido completion for `find-file\\=':
+Enable ido completion for `find-file':
(find-file . ido)
@@ -144,33 +144,33 @@ same as
(find-file . ido-read-file-name)
-Note that you don\\='t need to enable `ido-mode\\=' for this to work, see
-`helm-mode\\=' documentation."
+Note that you don't need to enable `ido-mode' for this to work, see
+`helm-mode' documentation."
:group 'helm-mode
:type '(alist :key-type symbol :value-type symbol))
(defcustom helm-comp-read-case-fold-search helm-case-fold-search
- "Default Local setting of `helm-case-fold-search\\=' for `helm-comp-read\\='.
-See `helm-case-fold-search\\=' for more info."
+ "Default Local setting of `helm-case-fold-search' for `helm-comp-read'.
+See `helm-case-fold-search' for more info."
:group 'helm-mode
:type 'symbol)
(defcustom helm-mode-handle-completion-in-region t
- "Whether to replace or not `completion-in-region-function\\='.
-This enables support for `completing-read-multiple\\=' and
`completion-at-point\\='
+ "Whether to replace or not `completion-in-region-function'.
+This enables support for `completing-read-multiple' and `completion-at-point'
when non--nil."
:group 'helm-mode
:type 'boolean)
(defcustom helm-mode-no-completion-in-region-in-modes nil
- "A list of modes that do not want helm for `completion-in-region\\='."
+ "A list of modes that do not want helm for `completion-in-region'."
:group 'helm-mode
:type 'boolean)
(defcustom helm-mode-reverse-history t
"Display history source after current source when non nil.
-Apply only in `helm-mode\\=' handled commands."
+Apply only in `helm-mode' handled commands."
:group 'helm-mode
:type 'boolean)
@@ -179,12 +179,12 @@ Apply only in `helm-mode\\=' handled commands."
"The default sort function to sort candidates in completion-in-region.
When nil no sorting is done.
-The function is a `filtered-candidate-transformer\\=' function which takes
+The function is a `filtered-candidate-transformer' function which takes
two args CANDIDATES and SOURCE.
-The function must use the flag `helm-completion--sorting-done\\=' and
+The function must use the flag `helm-completion--sorting-done' and
return CANDIDATES unchanged when the flag is nil.
-See default function `helm-completion-in-region-sort-fn\\=' as example.
-It will be used only when `helm-completion-style\\=' is either Emacs or
+See default function `helm-completion-in-region-sort-fn' as example.
+It will be used only when `helm-completion-style' is either Emacs or
helm, otherwise when helm-fuzzy style is used, the fuzzy sort function
will be used."
:group 'helm-mode
@@ -201,24 +201,24 @@ will be used."
:type 'boolean)
(defcustom helm-read-file-name-use-default-arg-behavior nil
- "Use emacs vanilla `read-file-name\\=' behavior for default arg.
+ "Use emacs vanilla `read-file-name' behavior for default arg.
-The behavior of default arg in `read-file-name\\=' and friends is using
+The behavior of default arg in `read-file-name' and friends is using
the default arg as default value when initial input is not modified,
even if this initial input is a valid value i.e. an existing file.
We expect generally a default arg to be used if nothing is specified
in the prompt or if what is specified is invalid, but the emacs behavior
here is really weird, so we use this variable to disable this
-behavior, letting user specify default if needed with `M-n\\='.
-However we keep the emacs default for `read-file-name\\=' and derived
-fns, this variable affecting only `helm-read-file-name\\='."
+behavior, letting user specify default if needed with `M-n'.
+However we keep the emacs default for `read-file-name' and derived
+fns, this variable affecting only `helm-read-file-name'."
:type 'boolean
:group 'helm-mode)
(defvar helm-mode-minibuffer-setup-hook-black-list
'(minibuffer-completion-help)
- "Incompatible `minibuffer-setup-hook\\=' functions go here.
-A list of symbols. `helm-mode\\=' is rejecting all lambda\\='s, byte-code fns
-and all functions belonging in this list from `minibuffer-setup-hook\\='.
+ "Incompatible `minibuffer-setup-hook' functions go here.
+A list of symbols. `helm-mode' is rejecting all lambda's, byte-code fns
+and all functions belonging in this list from `minibuffer-setup-hook'.
This is mainly needed to prevent \"*Completions*\" buffers to popup.")
(defface helm-mode-prefix
@@ -233,7 +233,7 @@ This is mainly needed to prevent \"*Completions*\" buffers
to popup.")
(define-key map (kbd "<C-return>") 'helm-cr-empty-string)
(define-key map (kbd "M-RET") 'helm-cr-empty-string)
map)
- "Keymap for `helm-comp-read\\='.")
+ "Keymap for `helm-comp-read'.")
(defun helm-mode-delete-char-backward-1 ()
(interactive)
@@ -267,16 +267,16 @@ letting the user start a new completion with a new
prefix."
'(helm-mode-delete-char-backward-1 helm-mode-delete-char-backward-2) 1)
(defcustom helm-completion-style 'helm
- "Style of completion to use in `completion-in-region\\='.
+ "Style of completion to use in `completion-in-region'.
-This affects only `completion-at-point\\=' and friends, and
-the `completing-read\\=' using the default handler
-i.e. `helm-completing-read-default-handler\\='.
+This affects only `completion-at-point' and friends, and
+the `completing-read' using the default handler
+i.e. `helm-completing-read-default-handler'.
-NB: This has nothing to do with `completion-styles\\=', it is independent from
-helm, but when using \\='emacs as helm-completion-style helm
-will use the `completion-styles\\=' for its completions.
-Up to the user to configure `completion-styles\\='.
+NB: This has nothing to do with `completion-styles', it is independent from
+helm, but when using 'emacs as helm-completion-style helm
+will use the `completion-styles' for its completions.
+Up to the user to configure `completion-styles'.
There are three possible values to use:
@@ -286,25 +286,25 @@ There are three possible values to use:
entering a space helm switches to multi matching mode.
- emacs, use regular Emacs completion according to
- `completion-styles\\='. Note that even in this style, helm allows using
- multi match. Emacs-27 provides a style called `flex\\=' that can be used
- aside `helm\\=' style (see `completion-styles-alist\\='). When `flex\\='
style
- is not available (Emacs<27) helm provides `helm-flex\\=' style which is
- similar to `flex\\=' and helm fuzzy matching.
-
-For a better experience with emacs style, if you don\\='t know what to use, set
-`completion-styles\\=' to \\='(flex) if you are using emacs-27 or to
-\\\='(helm-flex) if you are using emacs-26 and keep \\='emacs as default
-value for `helm-completion-style\\='. Advanced users can also have a
-look to `completion-category-overrides\\=' to set styles according to category.
-You can as well use `helm-completion-styles-alist\\=' to override
-`helm-completion-style\\=' in specific modes.
-
-Of course when using `helm\\=' of `helm-fuzzy\\=' as `helm-completion-style\\='
-emacs `completion-styles\\=' have no effect.
-
-Please use custom interface or `customize-set-variable\\=' to set this,
-NOT `setq\\='."
+ `completion-styles'. Note that even in this style, helm allows using
+ multi match. Emacs-27 provides a style called `flex' that can be used
+ aside `helm' style (see `completion-styles-alist'). When `flex' style
+ is not available (Emacs<27) helm provides `helm-flex' style which is
+ similar to `flex' and helm fuzzy matching.
+
+For a better experience with emacs style, if you don't know what to use, set
+`completion-styles' to '(flex) if you are using emacs-27 or to
+\'(helm-flex) if you are using emacs-26 and keep 'emacs as default
+value for `helm-completion-style'. Advanced users can also have a
+look to `completion-category-overrides' to set styles according to category.
+You can as well use `helm-completion-styles-alist' to override
+`helm-completion-style' in specific modes.
+
+Of course when using `helm' of `helm-fuzzy' as `helm-completion-style'
+emacs `completion-styles' have no effect.
+
+Please use custom interface or `customize-set-variable' to set this,
+NOT `setq'."
:group 'helm-mode
:type '(choice (const :tag "Emacs" emacs)
(const :tag "Helm" helm)
@@ -330,16 +330,16 @@ NOT `setq\\='."
(defcustom helm-completion-styles-alist '((gud-mode . helm)
;; See
https://github.com/djcb/mu/issues/2181.
(mu4e-compose-mode . emacs))
- "Allow configuring `helm-completion-style\\=' per mode.
+ "Allow configuring `helm-completion-style' per mode.
Each entry is a cons cell like (mode . style) where style must be a
-suitable value for `helm-completion-style\\='.
-When specifying emacs as style for a mode, `completion-styles\\=' can be
+suitable value for `helm-completion-style'.
+When specifying emacs as style for a mode, `completion-styles' can be
specified by using a cons cell specifying completion-styles to use
with helm emacs style, e.g. (foo-mode . (emacs helm flex)) will set
-`completion-styles\\=' to \\='(helm flex) for foo-mode. This affects only
+`completion-styles' to '(helm flex) for foo-mode. This affects only
completions happening in buffers and not minibuffer completions,
-i.e. completing-read\\='s."
+i.e. completing-read's."
:group 'helm-mode
:type
`(alist :key-type (symbol :tag "Major Mode")
@@ -357,13 +357,13 @@ i.e. completing-read\\='s."
;;
;;
(defvar helm-comp-read-use-marked nil
- "[INTERNAL] When non nil `helm-comp-read\\=' will return marked candidates.
+ "[INTERNAL] When non nil `helm-comp-read' will return marked candidates.
-Use this ONLY in `let\\=', NOT globally, this allows third party packages
-to use a list as return value when `helm-mode\\=' is enabled, e.g.
+Use this ONLY in `let', NOT globally, this allows third party packages
+to use a list as return value when `helm-mode' is enabled, e.g.
(let ((helm-comp-read-use-marked t))
- (completing-read \"test: \" \\='(a b c d e f g)))
+ (completing-read \"test: \" '(a b c d e f g)))
")
@@ -385,21 +385,21 @@ to use a list as return value when `helm-mode\\=' is
enabled, e.g.
(cl-defun helm-comp-read-get-candidates (collection &optional
test sort-fn alistp
(input helm-pattern))
- "Convert COLLECTION to list removing elements that don\\='t match TEST.
-See `helm-comp-read\\=' about supported COLLECTION arguments.
+ "Convert COLLECTION to list removing elements that don't match TEST.
+See `helm-comp-read' about supported COLLECTION arguments.
SORT-FN is a predicate to sort COLLECTION.
-ALISTP when non--nil will not use `all-completions\\=' to collect
-candidates because it doesn\\='t handle alists correctly for helm.
-i.e In `all-completions\\=' the car of each pair is used as value.
-In helm we want to use the cdr instead like (display . real),
+ALISTP when non--nil will not use `all-completions' to collect
+candidates because it doesn't handle alists correctly for helm.
+i.e In `all-completions' the car of each pair is used as value.
+In helm we want to use the cdr instead like \(display . real\),
so we return the alist as it is with no transformation by
-`all-completions\\='.
+`all-completions'.
e.g
-\(setq A \\='((a . 1) (b . 2) (c . 3)))
+\(setq A '((a . 1) (b . 2) (c . 3)))
==>((a . 1) (b . 2) (c . 3))
\(helm-comp-read \"test: \" A :alistp nil
:exec-when-only-one t
@@ -411,19 +411,19 @@ e.g
:initial-input \"1\")
==>\"1\"
-See docstring of `all-completions\\=' for more info.
+See docstring of `all-completions' for more info.
INPUT is the string you want to complete against, defaulting to
-`helm-pattern\\=' which is the value of what you enter in minibuffer.
+`helm-pattern' which is the value of what you enter in minibuffer.
Note that when using a function as COLLECTION this value will be
available with the input argument of the function only when using a
-sync source from `helm-comp-read\\=', i.e. not using
-`:candidates-in-buffer\\=', otherwise the function is called only once
-with an empty string as value for `helm-pattern\\=' because
-`helm-pattern\\=' is not yet computed, which is what we want otherwise
+sync source from `helm-comp-read', i.e. not using
+`:candidates-in-buffer', otherwise the function is called only once
+with an empty string as value for `helm-pattern' because
+`helm-pattern' is not yet computed, which is what we want otherwise
data would not be fully collected at init time.
-If COLLECTION is an `obarray\\=', a TEST should be needed. See `obarray\\='."
+If COLLECTION is an `obarray', a TEST should be needed. See `obarray'."
;; Ensure COLLECTION is computed from `helm-current-buffer'
;; because some functions used as COLLECTION work
;; only in the context of current-buffer (Bug#1030) .
@@ -494,7 +494,7 @@ If COLLECTION is an `obarray\\=', a TEST should be needed.
See `obarray\\='."
(member (upcase pattern) candidates)))
(defun helm-cr-default-transformer (candidates source)
- "Default filter candidate function for `helm-comp-read\\='."
+ "Default filter candidate function for `helm-comp-read'."
(let ((must-match (helm-get-attr 'must-match source)))
(cl-loop for c in candidates
for cand = (let ((elm (if (stringp c)
@@ -589,7 +589,7 @@ If COLLECTION is an `obarray\\=', a TEST should be needed.
See `obarray\\='."
(group 'helm))
"Read a string in the minibuffer, with helm completion.
-It is helm `completing-read\\=' equivalent.
+It is helm `completing-read' equivalent.
- PROMPT is the prompt name to use.
@@ -597,18 +597,18 @@ It is helm `completing-read\\=' equivalent.
For alists and hash-tables their car are use as real value of
candidate unless ALISTP is non-nil.
It can be also a function that receives three arguments:
- the values string, predicate and t. See `all-completions\\=' for more
details.
+ the values string, predicate and t. See `all-completions' for more details.
Keys description:
- TEST: A predicate called with one arg i.e candidate.
-- INITIAL-INPUT: Same as input arg in `helm\\='.
+- INITIAL-INPUT: Same as input arg in `helm'.
-- PRESELECT: See preselect arg of `helm\\='.
+- PRESELECT: See preselect arg of `helm'.
- DEFAULT: This option is used only for compatibility with regular
- Emacs `completing-read\\=' (Same as DEFAULT arg of `completing-read\\=').
+ Emacs `completing-read' (Same as DEFAULT arg of `completing-read').
- BUFFER: Name of helm-buffer.
@@ -628,9 +628,9 @@ Keys description:
The main difference with INPUT-HISTORY is that the result of the
completion is saved whereas in INPUT-HISTORY it is the minibuffer
contents which is saved when you exit.
- Don\\='t use the same symbol for INPUT-HISTORY and HISTORY.
+ Don't use the same symbol for INPUT-HISTORY and HISTORY.
NOTE: As mentionned above this has nothing to do with
- `minibuffer-history-variable\\=', therefore if you want to save this
+ `minibuffer-history-variable', therefore if you want to save this
history persistently, you will have to add this variable to the
relevant variable of your favorite tool for persistent emacs session
i.e. psession, desktop etc...
@@ -639,79 +639,79 @@ Keys description:
HISTORY candidates.
- INPUT-HISTORY: A symbol. The minibuffer input history will be
- stored there, if nil or not provided, `minibuffer-history\\='
+ stored there, if nil or not provided, `minibuffer-history'
will be used instead. You can navigate in this history with
- `M-p\\=' and `M-n\\='.
- Don\\='t use the same symbol for INPUT-HISTORY and HISTORY.
+ `M-p' and `M-n'.
+ Don't use the same symbol for INPUT-HISTORY and HISTORY.
-- CASE-FOLD: Same as `helm-case-fold-search\\='.
+- CASE-FOLD: Same as `helm-case-fold-search'.
- PERSISTENT-ACTION: A function called with one arg i.e candidate.
- PERSISTENT-HELP: A string to document PERSISTENT-ACTION.
- MODE-LINE: A string or list to display in mode line.
- Default is `helm-comp-read-mode-line\\='.
+ Default is `helm-comp-read-mode-line'.
-- KEYMAP: A keymap to use in this `helm-comp-read\\='.
+- KEYMAP: A keymap to use in this `helm-comp-read'.
(the keymap will be shared with history source)
- NAME: The name related to this local source.
-- HEADER-NAME: A function to alter NAME, see `helm\\='.
+- HEADER-NAME: A function to alter NAME, see `helm'.
-- EXEC-WHEN-ONLY-ONE: Bound `helm-execute-action-at-once-if-one\\='
+- EXEC-WHEN-ONLY-ONE: Bound `helm-execute-action-at-once-if-one'
to non--nil. (possibles values are t or nil).
- VOLATILE: Use volatile attribute.
-- SORT: A predicate to give to `sort\\=' e.g `string-lessp\\='
+- SORT: A predicate to give to `sort' e.g `string-lessp'
Use this only on small data as it is inefficient.
If you want to sort faster add a sort function to
FC-TRANSFORMER.
Note that FUZZY when enabled is already providing a sort function.
-- FC-TRANSFORMER: A `filtered-candidate-transformer\\=' function
+- FC-TRANSFORMER: A `filtered-candidate-transformer' function
or a list of functions.
-- HIST-FC-TRANSFORMER: A `filtered-candidate-transformer\\='
+- HIST-FC-TRANSFORMER: A `filtered-candidate-transformer'
function for the history source.
- MARKED-CANDIDATES: If non-nil return candidate or marked candidates as a
list.
-- NOMARK: When non--nil don\\='t allow marking candidates.
+- NOMARK: When non--nil don't allow marking candidates.
- ALISTP:
When non-nil (default) pass the value of (DISPLAY . REAL)
candidate in COLLECTION to action when COLLECTION is an alist or a
hash-table, otherwise DISPLAY is always returned as result on exit,
- which is the default when using `completing-read\\='.
- See `helm-comp-read-get-candidates\\='.
+ which is the default when using `completing-read'.
+ See `helm-comp-read-get-candidates'.
- CANDIDATES-IN-BUFFER: when non--nil use a source build with
- `helm-source-in-buffer\\=' which is much faster.
+ `helm-source-in-buffer' which is much faster.
Argument VOLATILE have no effect when CANDIDATES-IN-BUFFER is non--nil.
- MATCH-PART: Allow matching only one part of candidate.
- See match-part documentation in `helm-source\\='.
+ See match-part documentation in `helm-source'.
-- MATCH-DYNAMIC: See match-dynamic in `helm-source-sync\\='
+- MATCH-DYNAMIC: See match-dynamic in `helm-source-sync'
It has no effect when used with CANDIDATES-IN-BUFFER.
-- ALLOW-NEST: Allow nesting this `helm-comp-read\\=' in a helm session.
- See `helm\\='.
+- ALLOW-NEST: Allow nesting this `helm-comp-read' in a helm session.
+ See `helm'.
-- MULTILINE: See multiline in `helm-source\\='.
+- MULTILINE: See multiline in `helm-source'.
-- COERCE: See coerce in `helm-source\\='.
+- COERCE: See coerce in `helm-source'.
-- GROUP: See group in `helm-source\\='.
+- GROUP: See group in `helm-source'.
-Any prefix args passed during `helm-comp-read\\=' invocation will be recorded
-in `helm-current-prefix-arg\\=', otherwise if prefix args were given before
-`helm-comp-read\\=' invocation, the value of `current-prefix-arg\\=' will be
used.
+Any prefix args passed during `helm-comp-read' invocation will be recorded
+in `helm-current-prefix-arg', otherwise if prefix args were given before
+`helm-comp-read' invocation, the value of `current-prefix-arg' will be used.
That means you can pass prefix args before or after calling a command
-that use `helm-comp-read\\='. See `helm-M-x\\=' for example."
+that use `helm-comp-read'. See `helm-M-x' for example."
;; Handle error with HISTORY:
;;
;; Should show helm with one source at first run and save result on
@@ -895,7 +895,7 @@ that use `helm-comp-read\\='. See `helm-M-x\\=' for
example."
(defun helm-completing-read-symbols
(prompt _collection test _require-match init
hist default _inherit-input-method name buffer)
- "Specialized function for fast symbols completion in `helm-mode\\='."
+ "Specialized function for fast symbols completion in `helm-mode'."
(require 'helm-elisp)
(or
(helm
@@ -929,10 +929,10 @@ that use `helm-comp-read\\='. See `helm-M-x\\=' for
example."
(prompt collection test require-match
init hist default _inherit-input-method
name buffer &optional cands-in-buffer exec-when-only-one)
- "Call `helm-comp-read\\=' with same args as `completing-read\\='.
-Extra optional arg CANDS-IN-BUFFER means use `candidates-in-buffer\\='
+ "Call `helm-comp-read' with same args as `completing-read'.
+Extra optional arg CANDS-IN-BUFFER means use `candidates-in-buffer'
method which is faster.
-It should be used when candidate list doesn\\='t need to be rebuilt
dynamically."
+It should be used when candidate list doesn't need to be rebuilt dynamically."
(let ((history (or (car-safe hist) hist))
(initial-input (helm-aif (pcase init
((pred (stringp)) init)
@@ -975,9 +975,9 @@ It should be used when candidate list doesn\\='t need to be
rebuilt dynamically.
(prompt collection predicate require-match
init hist default _inherit-input-method
name buffer &optional _cands-in-buffer exec-when-only-one)
- "Call `helm-comp-read\\=' with same args as `completing-read\\='.
+ "Call `helm-comp-read' with same args as `completing-read'.
-This handler uses dynamic matching which allows honouring
`completion-styles\\='."
+This handler uses dynamic matching which allows honouring `completion-styles'."
(let* ((history (or (car-safe hist) hist))
(input (pcase init
((pred (stringp)) init)
@@ -1077,7 +1077,7 @@ This handler uses dynamic matching which allows honouring
`completion-styles\\='
(prompt collection test require-match
init hist default inherit-input-method
name buffer)
- "Specialized `helm-mode\\=' handler for `find-tag\\='."
+ "Specialized `helm-mode' handler for `find-tag'."
;; Some commands like find-tag may use `read-file-name' from inside
;; the calculation of collection. in this case it clash with
;; candidates-in-buffer that reuse precedent data (files) which is wrong.
@@ -1092,7 +1092,7 @@ This handler uses dynamic matching which allows honouring
`completion-styles\\='
(prompt collection test require-match
init hist default inherit-input-method
name buffer)
- "`helm-mode\\=' handler using sync source as backend."
+ "`helm-mode' handler using sync source as backend."
(helm-completing-read-default-1 prompt collection test require-match
init hist default inherit-input-method
name buffer))
@@ -1101,7 +1101,7 @@ This handler uses dynamic matching which allows honouring
`completion-styles\\='
(prompt collection test require-match
init hist default inherit-input-method
name buffer)
- "`helm-mode\\=' handler using inbuffer source as backend."
+ "`helm-mode' handler using inbuffer source as backend."
(helm-completing-read-default-1 prompt collection test require-match
init hist default inherit-input-method
name buffer t))
@@ -1110,7 +1110,7 @@ This handler uses dynamic matching which allows honouring
`completion-styles\\='
(prompt collection test require-match
init hist default inherit-input-method
name buffer)
- "Default `helm-mode\\=' handler for all `completing-read\\='."
+ "Default `helm-mode' handler for all `completing-read'."
(let* (;; Standard will be used as CANDS-IN-BUFFER arg.
(standard (and (memq helm-completion-style '(helm helm-fuzzy)) t))
(fn (if standard
@@ -1123,8 +1123,8 @@ This handler uses dynamic matching which allows honouring
`completion-styles\\='
standard)))
(defun helm-mode--read-buffer-to-switch (prompt)
- "[INTERNAL] This is used to advice `read-buffer-to-switch\\='.
-Don\\='t use it directly."
+ "[INTERNAL] This is used to advice `read-buffer-to-switch'.
+Don't use it directly."
;; `read-buffer-to-switch' is passing `minibuffer-completion-table'
;; to `read-buffer' through `minibuffer-setup-hook' which is too
;; late to be known by `read-buffer-function', in our case
@@ -1135,8 +1135,8 @@ Don\\='t use it directly."
(confirm-nonexistent-file-or-buffer))))
(defun helm--generic-read-buffer (prompt &optional default require-match
predicate)
- "The `read-buffer-function\\=' for `helm-mode\\='.
-Affects `switch-to-buffer\\=' `kill-buffer\\=' and related."
+ "The `read-buffer-function' for `helm-mode'.
+Affects `switch-to-buffer' `kill-buffer' and related."
;; `read-buffer' is using internally `Vbuffer_alist' which is an
;; alist with elements like (BUF-NAME . BUF-OBJ), therefore some
;; predicates in Emacs are working only on such cons cells.
@@ -1175,12 +1175,12 @@ Affects `switch-to-buffer\\=' `kill-buffer\\=' and
related."
predicate require-match
initial-input hist def
inherit-input-method)
- "An helm replacement of `completing-read\\='.
-This function should be used only as a `completing-read-function\\='.
+ "An helm replacement of `completing-read'.
+This function should be used only as a `completing-read-function'.
-Don\\='t use it directly, use instead `helm-comp-read\\=' in your programs.
+Don't use it directly, use instead `helm-comp-read' in your programs.
-See documentation of `completing-read\\=' and `all-completions\\=' for
details."
+See documentation of `completing-read' and `all-completions' for details."
(let* ((current-command (or (helm-this-command) this-command))
(str-command (if current-command
(helm-symbol-name current-command)
@@ -1299,7 +1299,7 @@ See documentation of `completing-read\\=' and
`all-completions\\=' for details."
(mode-line helm-read-file-name-mode-line-string))
"Read a file name with helm completion.
-It is helm `read-file-name\\=' emulation.
+It is helm `read-file-name' emulation.
Argument PROMPT is the default prompt to use.
@@ -1308,30 +1308,30 @@ Keys description:
- NAME: Source name, default to \"Read File Name\".
- INITIAL-INPUT: Where to start reading file name,
- default to `default-directory\\=' or $HOME.
+ default to `default-directory' or $HOME.
-- BUFFER: `helm-buffer\\=' name, defaults to \"*Helm Completions*\".
+- BUFFER: `helm-buffer' name, defaults to \"*Helm Completions*\".
-- TEST: A predicate called with one arg \\='candidate\\='.
+- TEST: A predicate called with one arg 'candidate'.
- NORET: Allow disabling helm-ff-RET (have no effect if helm-ff-RET
- isn\\='t bound to RET).
+ isn't bound to RET).
-- CASE-FOLD: Same as `helm-case-fold-search\\='.
+- CASE-FOLD: Same as `helm-case-fold-search'.
- PRESELECT: helm preselection.
- HISTORY: Display HISTORY in a special source.
-- MUST-MATCH: Can be \\='confirm, nil, or t.
+- MUST-MATCH: Can be 'confirm, nil, or t.
- FUZZY: Enable fuzzy matching when non-nil (Enabled by default).
- MARKED-CANDIDATES: When non--nil return a list of marked candidates.
-- NOMARK: When non--nil don\\='t allow marking candidates.
+- NOMARK: When non--nil don't allow marking candidates.
-- ALISTP: Don\\='t use `all-completions\\=' in history
+- ALISTP: Don't use `all-completions' in history
(take effect only on history).
- PERSISTENT-ACTION-IF: a persistent if action function.
@@ -1339,7 +1339,7 @@ Keys description:
- PERSISTENT-HELP: persistent help message.
- MODE-LINE: A mode line message, default is
- `helm-read-file-name-mode-line-string\\='."
+ `helm-read-file-name-mode-line-string'."
(require 'tramp)
(unless initial-input
(setq initial-input (or default-directory (getenv "HOME"))))
@@ -1482,8 +1482,8 @@ Keys description:
(cl-defun helm--generic-read-file-name
(prompt &optional dir default-filename mustmatch initial predicate)
- "Generic helm replacement of `read-file-name\\='.
-Don\\='t use it directly, use instead `helm-read-file-name\\=' in your
programs."
+ "Generic helm replacement of `read-file-name'.
+Don't use it directly, use instead `helm-read-file-name' in your programs."
(let* ((init (or initial dir default-directory))
(helm-read-file-name-use-default-arg-behavior t)
(current-command (or (helm-this-command) this-command))
@@ -1616,10 +1616,10 @@ Don\\='t use it directly, use instead
`helm-read-file-name\\=' in your programs.
(defun helm-read-file-name-handler-1 (prompt dir default-filename
mustmatch initial predicate
name buffer)
- "A `read-file-name\\=' handler with history.
-Can be added to `helm-completing-read-handlers-alist\\=' for functions
-that need a `read-file-name\\=' function with directory history.
-The `helm-find-files\\=' history `helm-ff-history\\=' is used here."
+ "A `read-file-name' handler with history.
+Can be added to `helm-completing-read-handlers-alist' for functions
+that need a `read-file-name' function with directory history.
+The `helm-find-files' history `helm-ff-history' is used here."
(let ((helm-always-two-windows t)
(helm-split-window-default-side
(if (eq helm-split-window-default-side 'same)
@@ -1655,7 +1655,7 @@ The `helm-find-files\\=' history `helm-ff-history\\=' is
used here."
(sort candidates 'helm-generic-sort-fn)))
(defun helm-mode--completion-in-region-initial-input (str)
- "Highlight prefix in helm and helm-fuzzy `helm-completion-styles\\='."
+ "Highlight prefix in helm and helm-fuzzy `helm-completion-styles'."
(if (memq helm-completion-style '(helm helm-fuzzy))
(propertize str 'read-only t 'face 'helm-mode-prefix 'rear-nonsticky t)
str))
@@ -1690,7 +1690,7 @@ The `helm-find-files\\=' history `helm-ff-history\\=' is
used here."
;; Helm multi matching style
(defun helm-completion-try-completion (string table pred point)
- "The try completion function for `completing-styles-alist\\='.
+ "The try completion function for `completing-styles-alist'.
Actually does nothing."
;; AFAIU the try-completions style functions
;; are here to check if what is at point is suitable for TABLE but
@@ -1702,7 +1702,7 @@ Actually does nothing."
(ignore string table pred point))
(defun helm-completion-all-completions (string table pred point)
- "The all completions function for `completing-styles-alist\\='."
+ "The all completions function for `completing-styles-alist'."
;; FIXME: No need to bind all these value.
;; (cl-multiple-value-bind (all _pattern prefix _suffix _carbounds)
(pcase-let ((`(,all ,_pattern ,prefix ,_suffix ,_carbounds)
@@ -1710,7 +1710,7 @@ Actually does nothing."
(when all (nconc all (length prefix)))))
(defun helm-completion--multi-all-completions-1 (string collection &optional
predicate)
- "Allow `all-completions\\=' multi matching on its candidates."
+ "Allow `all-completions' multi matching on its candidates."
;; Doing an initial call of all-completions on the first element of
;; STRING speedup completion and fix file completion when CAPF
;; returns relative paths to initial pattern (eshell and shell).
@@ -1800,7 +1800,7 @@ Actually does nothing."
;; Helm-flex style.
;; This is more or less the same as emacs-27 flex style.
(defun helm-flex-completion-try-completion (string table pred point)
- "The try completion function for `completing-styles-alist\\='."
+ "The try completion function for `completing-styles-alist'."
;; It is needed here to make minibuffer-complete work in emacs-26,
;; e.g. with regular M-x.
(unless (string-match-p " " string)
@@ -1811,7 +1811,7 @@ Actually does nothing."
(completion-pcm--merge-try pattern all prefix suffix))))
(defun helm-flex-completion-all-completions (string table pred point)
- "The all completions function for `completing-styles-alist\\='."
+ "The all completions function for `completing-styles-alist'."
;; FIXME: No need to bind all these value.
(unless (string-match-p " " string)
(pcase-let ((`(,all ,pattern ,prefix ,_suffix ,_carbounds)
@@ -1852,11 +1852,11 @@ is non-nil."
;; Completion-in-region-function
(defun helm--completion-in-region (origfun start end collection &optional
predicate)
- "Helm replacement of `completion--in-region\\='.
+ "Helm replacement of `completion--in-region'.
-Can be used for `completion-in-region-function\\=' by advicing it with an
+Can be used for `completion-in-region-function' by advicing it with an
:around advice to allow passing the old
-`completion-in-region-function\\=' value in ORIGFUN."
+`completion-in-region-function' value in ORIGFUN."
(cl-declare (special require-match prompt))
(if (memq major-mode helm-mode-no-completion-in-region-in-modes)
(funcall origfun start end collection predicate)
@@ -2048,13 +2048,13 @@ Can be used for `completion-in-region-function\\=' by
advicing it with an
#'helm-mode--advice-lisp--local-variables)))))
(defvar helm-crm-default-separator ","
- "Default separator for `completing-read-multiple\\='.
+ "Default separator for `completing-read-multiple'.
-`crm-separator\\=' will take precedence on this when it is a string composed
+`crm-separator' will take precedence on this when it is a string composed
of a single character.
If used globally, it is a string composed of a single character,
if let-bounded, it can be also nil or a symbol which mean no
-separator. Don\\='t set this to a string composed of more than one
+separator. Don't set this to a string composed of more than one
character.
Be sure to know what you are doing when modifying this.")
(defun helm-completion-in-region--insert-result (result start point end
base-size)
@@ -2126,21 +2126,21 @@ Be sure to know what you are doing when modifying
this.")
(define-minor-mode helm-mode
"Toggle generic helm completion.
-All functions in Emacs that use `completing-read\\=',
-`read-file-name\\=', `completion-in-region\\=' and friends will use helm
+All functions in Emacs that use `completing-read',
+`read-file-name', `completion-in-region' and friends will use helm
interface when this mode is turned on.
However you can modify this behavior for functions of your choice
-with `helm-completing-read-handlers-alist\\='.
+with `helm-completing-read-handlers-alist'.
Called with a positive arg, turn on unconditionally, with a
negative arg turn off.
-You can toggle it with M-x `helm-mode\\='.
+You can toggle it with M-x `helm-mode'.
-About `ido-mode\\=':
-DO NOT enable `ido-everywhere\\=' when using `helm-mode\\='. Instead of
-using `ido-mode\\=', add the commands where you want to use ido to
-`helm-completing-read-handlers-alist\\=' with `ido\\=' as value.
+About `ido-mode':
+DO NOT enable `ido-everywhere' when using `helm-mode'. Instead of
+using `ido-mode', add the commands where you want to use ido to
+`helm-completing-read-handlers-alist' with `ido' as value.
Note: This mode is incompatible with Emacs23."
:group 'helm-mode
diff --git a/helm-multi-match.el b/helm-multi-match.el
index 4b8421a87e..0e55cdb152 100644
--- a/helm-multi-match.el
+++ b/helm-multi-match.el
@@ -68,7 +68,7 @@ when these options are used."
(defun helm-mm-split-pattern (pattern &optional grep-space)
"Split PATTERN if it contains spaces and return resulting list.
-If spaces in PATTERN are escaped, don\\='t split at this place.
+If spaces in PATTERN are escaped, don't split at this place.
i.e \"foo bar baz\"=> (\"foo\" \"bar\" \"baz\")
but \"foo\\ bar baz\"=> (\"foo\\s-bar\" \"baz\").
If GREP-SPACE is used translate escaped space to \"\\s\" instead of \"\\s-\"."
@@ -80,7 +80,7 @@ If GREP-SPACE is used translate escaped space to \"\\s\"
instead of \"\\s-\"."
(if grep-space "\\s" "\\s-") pattern nil t)))
(defun helm-mm-1-make-regexp (pattern)
- "Replace spaces in PATTERN with \".*\"."
+ "Replace spaces in PATTERN with \"\.*\"."
(mapconcat 'identity (helm-mm-split-pattern pattern) ".*"))
@@ -189,8 +189,8 @@ If GREP-SPACE is used translate escaped space to \"\\s\"
instead of \"\\s-\"."
(defun helm-mm-3-get-patterns (pattern)
"Return a list of predicate/regexp cons cells.
E.g., ((identity . \"foo\") (not . \"bar\")).
-If PATTERN is unchanged, don\\='t recompute PATTERN and return the
-previous value stored in `helm-mm--3-pattern-list\\='."
+If PATTERN is unchanged, don't recompute PATTERN and return the
+previous value stored in `helm-mm--3-pattern-list'."
(unless (equal pattern helm-mm--3-pattern-str)
(setq helm-mm--3-pattern-str pattern
helm-mm--3-pattern-list
@@ -217,7 +217,7 @@ When PATTERN contains a space, it is splitted and matching
is
done with the several resulting regexps against CANDIDATE.
E.g., \"bar foo\" will match \"foobar\" and \"barfoo\".
Argument PATTERN, a string, is transformed in a list of cons cell
-with `helm-mm-3-get-patterns\\=' if it contains a space.
+with `helm-mm-3-get-patterns' if it contains a space.
E.g., \"foo bar\"=>((identity . \"foo\") (identity . \"bar\")).
Then each predicate of cons cell(s) is called with the regexp of
the same cons cell against CANDIDATE.
@@ -237,9 +237,9 @@ I.e. (identity (string-match \"foo\" \"foo bar\")) => t."
(invalid-regexp nil))))))
(defun helm-mm-3-search-base (pattern searchfn1 searchfn2)
- "Try to find PATTERN in `helm-buffer\\=' with SEARCHFN1 and SEARCHFN2.
-This is the search function for `candidates-in-buffer\\=' enabled sources.
-Use the same method as `helm-mm-3-match\\=' except it search in buffer
+ "Try to find PATTERN in `helm-buffer' with SEARCHFN1 and SEARCHFN2.
+This is the search function for `candidates-in-buffer' enabled sources.
+Use the same method as `helm-mm-3-match' except it search in buffer
instead of matching on a string.
i.e (identity (re-search-forward \"foo\" (point-at-eol) t)) => t."
(cl-loop with pat = (if (stringp pattern)
@@ -313,7 +313,7 @@ i.e. the sources which have the slot :migemo with non--nil
value."
(concat regex "\\|" pattern) pattern)))
(defun helm-mm-migemo-string-match (pattern str)
- "Migemo version of `string-match\\='."
+ "Migemo version of `string-match'."
(unless (assoc pattern helm-mm--previous-migemo-info)
(with-helm-buffer
(setq helm-mm--previous-migemo-info
@@ -324,8 +324,8 @@ i.e. the sources which have the slot :migemo with non--nil
value."
(defun helm-mm-diacritics-string-match (pattern str)
"Check if PATTERN match STR ignoring diacritics.
-If PATTERN is a regexp (i.e. `helm-mm-regexp-p\\=') use PATTERN
-unmodified, otherwise transform PATTERN with `char-fold-to-regexp\\='.
+If PATTERN is a regexp (i.e. `helm-mm-regexp-p') use PATTERN
+unmodified, otherwise transform PATTERN with `char-fold-to-regexp'.
This function is used to search match-part of candidate in in-buffer
sources."
@@ -361,10 +361,10 @@ sources."
;;
(defun helm-mm-3p-match (candidate &optional pattern)
"Check if PATTERN match CANDIDATE.
-Same as `helm-mm-3-match\\=' but only for the cdr of patterns, the car of
+Same as `helm-mm-3-match' but only for the cdr of patterns, the car of
patterns must always match CANDIDATE prefix.
E.g. \"bar foo baz\" will match \"barfoobaz\" or \"barbazfoo\" but not
-\"foobarbaz\" whereas `helm-mm-3-match\\=' would match all."
+\"foobarbaz\" whereas `helm-mm-3-match' would match all."
(let* ((pat (helm-mm-3-get-patterns (or pattern helm-pattern)))
(first (car pat)))
(and (funcall (car first) (helm-mm-prefix-match candidate (cdr first)))
@@ -380,7 +380,7 @@ E.g. \"bar foo baz\" will match \"barfoobaz\" or
\"barbazfoo\" but not
;;
;;
(cl-defun helm-mm-match (candidate &optional (pattern helm-pattern))
- "Call `helm-mm-matching-method\\=' function against CANDIDATE."
+ "Call `helm-mm-matching-method' function against CANDIDATE."
(let ((fun (cl-ecase helm-mm-matching-method
(multi1 #'helm-mm-1-match)
(multi2 #'helm-mm-2-match)
@@ -389,12 +389,12 @@ E.g. \"bar foo baz\" will match \"barfoobaz\" or
\"barbazfoo\" but not
(funcall fun candidate pattern)))
(cl-defun helm-mm-3-match-on-diacritics (candidate &optional (pattern
helm-pattern))
- "Same as `helm-mm-3-match\\=' but match on diacritics if possible."
+ "Same as `helm-mm-3-match' but match on diacritics if possible."
(let ((helm-mm--match-on-diacritics t))
(helm-mm-match candidate pattern)))
(defun helm-mm-search (pattern &rest _ignore)
- "Search for PATTERN with `helm-mm-matching-method\\=' function."
+ "Search for PATTERN with `helm-mm-matching-method' function."
(let ((fun (cl-ecase helm-mm-matching-method
(multi1 #'helm-mm-1-search)
(multi2 #'helm-mm-2-search)
diff --git a/helm-net.el b/helm-net.el
index 2c31ae785e..e60e9cad28 100644
--- a/helm-net.el
+++ b/helm-net.el
@@ -34,7 +34,7 @@
(defcustom helm-google-suggest-default-browser-function nil
"The browse url function you prefer to use with Google suggest.
When nil, use the first browser function available
-See `helm-browse-url-default-browser-alist\\='."
+See `helm-browse-url-default-browser-alist'."
:group 'helm-net
:type 'symbol)
@@ -45,21 +45,21 @@ See `helm-browse-url-default-browser-alist\\='."
(defcustom helm-surfraw-default-browser-function nil
"The browse url function you prefer to use with surfraw.
-When nil, fallback to `browse-url-browser-function\\='."
+When nil, fallback to `browse-url-browser-function'."
:group 'helm-net
:type 'symbol)
(defcustom helm-google-suggest-url
"https://encrypted.google.com/complete/search?output=toolbar&q=%s";
"URL used for looking up Google suggestions.
-This is a format string, don\\='t forget the `%s\\='."
+This is a format string, don't forget the `%s'."
:type 'string
:group 'helm-net)
(defcustom helm-google-suggest-search-url
"https://encrypted.google.com/search?ie=utf-8&oe=utf-8&q=%s";
"URL used for Google searching.
-This is a format string, don\\='t forget the `%s\\='."
+This is a format string, don't forget the `%s'."
:type 'string
:group 'helm-net)
@@ -68,14 +68,14 @@ This is a format string, don\\='t forget the `%s\\='."
(defcustom helm-net-prefer-curl nil
"When non--nil use CURL external program to fetch data.
-Otherwise `url-retrieve-synchronously\\=' is used."
+Otherwise `url-retrieve-synchronously' is used."
:type 'boolean
:group 'helm-net)
(defcustom helm-surfraw-duckduckgo-url
"https://duckduckgo.com/lite/?q=%s&kp=1";
"The Duckduckgo url.
-This is a format string, don\\='t forget the `%s\\='.
+This is a format string, don't forget the `%s'.
If you have personal settings saved on duckduckgo you should have
a personal url, see your settings on duckduckgo."
:type 'string
@@ -84,35 +84,35 @@ a personal url, see your settings on duckduckgo."
(defcustom helm-search-suggest-action-wikipedia-url
"https://en.wikipedia.org/wiki/Special:Search?search=%s";
"The Wikipedia search url.
-This is a format string, don\\='t forget the `%s\\='."
+This is a format string, don't forget the `%s'."
:type 'string
:group 'helm-net)
(defcustom helm-search-suggest-action-youtube-url
"https://www.youtube.com/results?aq=f&search_query=%s";
"The Youtube search url.
-This is a format string, don\\='t forget the `%s\\='."
+This is a format string, don't forget the `%s'."
:type 'string
:group 'helm-net)
(defcustom helm-search-suggest-action-imdb-url
"http://www.imdb.com/find?s=all&q=%s";
"The IMDb search url.
-This is a format string, don\\='t forget the `%s\\='."
+This is a format string, don't forget the `%s'."
:type 'string
:group 'helm-net)
(defcustom helm-search-suggest-action-google-maps-url
"https://maps.google.com/maps?f=q&source=s_q&q=%s";
"The Google Maps search url.
-This is a format string, don\\='t forget the `%s\\='."
+This is a format string, don't forget the `%s'."
:type 'string
:group 'helm-net)
(defcustom helm-search-suggest-action-google-news-url
"https://www.google.com/search?safe=off&prmd=nvlifd&source=lnms&tbs=nws:1&q=%s";
"The Google News search url.
-This is a format string, don\\='t forget the `%s\\='."
+This is a format string, don't forget the `%s'."
:type 'string
:group 'helm-net)
@@ -152,7 +152,7 @@ Can be \"--new-tab\" (default), \"--new-window\" or
\"--private-window\"."
(const :tag "New private window" "--private-window")))
(defcustom helm-net-curl-switches '("-s" "-L")
- "Arguments list passed to curl when using `helm-net-prefer-curl\\='."
+ "Arguments list passed to curl when using `helm-net-prefer-curl'."
:group 'helm-net
:type '(repeat string))
@@ -235,7 +235,7 @@ Can be \"--new-tab\" (default), \"--new-window\" or
\"--private-window\"."
(defvar helm-google-suggest-default-function
'helm-google-suggest-set-candidates
- "Default function to use in `helm-google-suggest\\='.")
+ "Default function to use in `helm-google-suggest'.")
(defvar helm-source-google-suggest
(helm-build-sync-source "Google Suggest"
@@ -296,7 +296,7 @@ Can be \"--new-tab\" (default), \"--new-window\" or
\"--private-window\"."
;;;###autoload
(defun helm-browse-url-firefox (url &optional _ignore)
- "Same as `browse-url-firefox\\=' but detach from Emacs.
+ "Same as `browse-url-firefox' but detach from Emacs.
So when you quit Emacs you can keep your Firefox session open and
not be prompted to kill the Firefox process.
@@ -392,7 +392,7 @@ NOTE: Probably not supported on some systems (e.g.,
Windows)."
;;;###autoload
(defun helm-surfraw (pattern engine)
- "Preconfigured `helm\\=' to search PATTERN with search ENGINE."
+ "Preconfigured `helm' to search PATTERN with search ENGINE."
(interactive
(list
(let* ((default (if (use-region-p)
@@ -427,7 +427,7 @@ NOTE: Probably not supported on some systems (e.g.,
Windows)."
;;;###autoload
(defun helm-google-suggest ()
- "Preconfigured `helm\\=' for Google search with Google suggest."
+ "Preconfigured `helm' for Google search with Google suggest."
(interactive)
(helm-other-buffer 'helm-source-google-suggest "*helm google*"))
diff --git a/helm-occur.el b/helm-occur.el
index a1f205ee24..38784b5108 100644
--- a/helm-occur.el
+++ b/helm-occur.el
@@ -32,11 +32,11 @@
;;; Internals
;;
(defvar helm-source-occur nil
- "This will be the name of the source related to `current-buffer\\='.
-Don\\='t use it as it value changes always.")
+ "This will be the name of the source related to `current-buffer'.
+Don't use it as it value changes always.")
(defvar helm-source-moccur nil
- "This is just a flag to add to `helm-sources-using-default-as-input\\='.
-Don\\='t set it to any value, it will have no effect.")
+ "This is just a flag to add to `helm-sources-using-default-as-input'.
+Don't set it to any value, it will have no effect.")
(defvar helm-occur--buffer-list nil)
(defvar helm-occur--buffer-tick nil)
(defvar helm-occur-history nil)
@@ -69,9 +69,9 @@ Don\\='t set it to any value, it will have no effect.")
:type '(alist :key-type string :value-type function))
(defcustom helm-occur-use-ioccur-style-keys nil
- "Similar to `helm-grep-use-ioccur-style-keys\\=' but for multi occur.
+ "Similar to `helm-grep-use-ioccur-style-keys' but for multi occur.
-Note that if you define this variable with `setq\\=' your change will
+Note that if you define this variable with `setq' your change will
have no effect, use customize instead."
:group 'helm-occur
:type 'boolean
@@ -97,7 +97,7 @@ have no effect, use customize instead."
(defcustom helm-occur-auto-update-on-resume nil
"Allow auto updating helm-occur buffer when outdated.
noask => Always update without asking
-nil => Don\\='t update but signal buffer needs update
+nil => Don't update but signal buffer needs update
never => Never update and do not signal buffer needs update
Any other non--nil value update after confirmation."
:group 'helm-regexp
@@ -108,7 +108,7 @@ Any other non--nil value update after confirmation."
(const :tag "Update after confirmation" t)))
(defcustom helm-occur-candidate-number-limit 99999
- "Value of `helm-candidate-number-limit\\=' for helm-occur."
+ "Value of `helm-candidate-number-limit' for helm-occur."
:group 'helm-occur
:type 'integer)
@@ -116,9 +116,9 @@ Any other non--nil value update after confirmation."
'((mu4e-headers-mode . buffer-substring))
"Function to use to display buffer contents for major-mode.
-Can be one of `buffer-substring\\=' or `buffer-substring-no-properties\\='.
+Can be one of `buffer-substring' or `buffer-substring-no-properties'.
-Note that when using `buffer-substring\\=' initialization will be slower."
+Note that when using `buffer-substring' initialization will be slower."
:group 'helm-regexp
:type '(alist :key-type (symbol :tag "Mode")
:value-type (radio (const :tag "With text properties"
buffer-substring)
@@ -126,8 +126,8 @@ Note that when using `buffer-substring\\=' initialization
will be slower."
(defcustom helm-occur-keep-closest-position t
"When non nil select closest candidate from point after update.
-This happen only in `helm-source-occur\\=' which is always related to
-`current-buffer\\='."
+This happen only in `helm-source-occur' which is always related to
+`current-buffer'."
:group 'helm-regexp
:type 'boolean)
@@ -183,20 +183,20 @@ This happen only in `helm-source-occur\\=' which is
always related to
;;;###autoload
(defun helm-occur ()
- "Preconfigured helm for searching lines matching pattern in
`current-buffer\\='.
+ "Preconfigured helm for searching lines matching pattern in
`current-buffer'.
-When `helm-source-occur\\=' is member of
-`helm-sources-using-default-as-input\\=' which is the default,
+When `helm-source-occur' is member of
+`helm-sources-using-default-as-input' which is the default,
symbol at point is searched at startup.
When a region is marked search only in this region by narrowing.
To search in multiples buffers start from one of the commands listing
-buffers (i.e. a helm command using `helm-source-buffers-list\\=' like
-`helm-mini\\=') and use the multi occur buffers action.
+buffers (i.e. a helm command using `helm-source-buffers-list' like
+`helm-mini') and use the multi occur buffers action.
This is the helm implementation that collect lines matching pattern
-like vanilla Emacs `occur\\=' but have nothing to do with it, the search
+like vanilla Emacs `occur' but have nothing to do with it, the search
engine beeing completely different and also much faster."
(interactive)
(setq helm-source-occur
@@ -277,7 +277,7 @@ engine beeing completely different and also much faster."
(find-file-target :initform #'helm-occur-quit-an-find-file-fn)))
(defun helm-occur-build-sources (buffers &optional source-name)
- "Build sources for `helm-occur\\=' for each buffer in BUFFERS list."
+ "Build sources for `helm-occur' for each buffer in BUFFERS list."
(cl-loop for buf in buffers
for bname = (buffer-name buf)
collect
@@ -334,8 +334,8 @@ engine beeing completely different and also much faster."
:moccur-buffers buffers)))
(defun helm-multi-occur-1 (buffers &optional input)
- "Run `helm-occur\\=' on a list of buffers.
-Each buffer\\='s result is displayed in a separated source."
+ "Run `helm-occur' on a list of buffers.
+Each buffer's result is displayed in a separated source."
(let* ((curbuf (current-buffer))
(bufs (if helm-occur-always-search-in-current
(cons curbuf (remove curbuf buffers))
@@ -410,25 +410,25 @@ METHOD can be one of buffer, buffer-other-window,
buffer-other-frame."
(defun helm-occur-goto-line-ow (candidate)
"Go to CANDIDATE line in other window.
-Same as `helm-occur-goto-line\\=' but go in other window."
+Same as `helm-occur-goto-line' but go in other window."
(helm-occur-action
candidate 'buffer-other-window))
(defun helm-occur-goto-line-of (candidate)
"Go to CANDIDATE line in new frame.
-Same as `helm-occur-goto-line\\=' but go in new frame."
+Same as `helm-occur-goto-line' but go in new frame."
(helm-occur-action
candidate 'buffer-other-frame))
(defun helm-occur-run-goto-line-ow ()
- "Run goto line other window action from `helm-occur\\='."
+ "Run goto line other window action from `helm-occur'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-occur-goto-line-ow)))
(put 'helm-occur-run-goto-line-ow 'helm-only t)
(defun helm-occur-run-goto-line-of ()
- "Run goto line new frame action from `helm-occur\\='."
+ "Run goto line new frame action from `helm-occur'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-occur-goto-line-of)))
@@ -441,15 +441,15 @@ Same as `helm-occur-goto-line\\=' but go in new frame."
(put 'helm-occur-run-default-action 'helm-only t)
(defun helm-occur-run-save-buffer ()
- "Run moccur save results action from `helm-moccur\\='."
+ "Run moccur save results action from `helm-moccur'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-occur-save-results)))
(put 'helm-moccur-run-save-buffer 'helm-only t)
(defun helm-occur-right ()
- "`helm-occur\\=' action for right arrow.
-This is used when `helm-occur-use-ioccur-style-keys\\=' is enabled.
+ "`helm-occur' action for right arrow.
+This is used when `helm-occur-use-ioccur-style-keys' is enabled.
If follow is enabled (default) go to next source, otherwise execute
persistent action."
(interactive)
@@ -514,7 +514,7 @@ persistent action."
(helm-occur-mode-goto-line-ow-forward-1 (- arg)))
(defun helm-occur-save-results (_candidate)
- "Save helm moccur results in a `helm-moccur-mode\\=' buffer."
+ "Save helm moccur results in a `helm-moccur-mode' buffer."
(let ((buf "*hmoccur*")
new-buf)
(when (get-buffer buf)
@@ -595,7 +595,7 @@ persistent action."
(defun helm-occur-buffer-substring-with-linums ()
"Return current-buffer contents as a string with all lines
-numbered. The property \\='buffer-name is added to the whole string."
+numbered. The property 'buffer-name is added to the whole string."
(let ((bufstr (buffer-substring-no-properties (point-min) (point-max)))
(bufname (buffer-name)))
(with-temp-buffer
@@ -610,7 +610,7 @@ numbered. The property \\='buffer-name is added to the
whole string."
(buffer-string))))
(defun helm-occur-mode--revert-buffer-function (&optional _ignore-auto
_noconfirm)
- "The `revert-buffer-function\\=' for `helm-occur-mode\\='."
+ "The `revert-buffer-function' for `helm-occur-mode'."
(goto-char (point-min))
(let (pattern)
(when (re-search-forward "^Occur Results for `\\(.*\\)'" nil t)
@@ -667,7 +667,7 @@ numbered. The property \\='buffer-name is added to the
whole string."
(message "Reverting buffer done"))))))
(defun helm-occur-filter-one-by-one (candidate)
- "`filter-one-by-one\\=' function for `helm-source-moccur\\='."
+ "`filter-one-by-one' function for `helm-source-moccur'."
(require 'helm-grep)
(let* ((split (helm-grep-split-line candidate))
(buf (car split))
@@ -702,9 +702,9 @@ Special commands:
(put 'helm-moccur-mode 'helm-only t)
(defun helm-occur-next-error (&optional argp reset)
- "Goto ARGP position from a `helm-occur-mode\\=' buffer.
+ "Goto ARGP position from a `helm-occur-mode' buffer.
RESET non-nil means rewind to the first match.
-This is the `next-error-function\\=' for `helm-occur-mode\\='."
+This is the `next-error-function' for `helm-occur-mode'."
(interactive "p")
(goto-char (cond (reset (point-min))
((< argp 0) (line-beginning-position))
@@ -778,9 +778,9 @@ This is the `next-error-function\\=' for
`helm-occur-mode\\='."
;;
;;;###autoload
(defun helm-occur-from-isearch ()
- "Invoke `helm-occur\\=' from isearch.
+ "Invoke `helm-occur' from isearch.
-To use this bind it to a key in `isearch-mode-map\\='."
+To use this bind it to a key in `isearch-mode-map'."
(interactive)
(let ((input (if isearch-regexp
isearch-string
@@ -794,14 +794,14 @@ To use this bind it to a key in `isearch-mode-map\\='."
;;;###autoload
(defun helm-multi-occur-from-isearch ()
- "Invoke `helm-multi-occur\\=' from isearch.
+ "Invoke `helm-multi-occur' from isearch.
With a prefix arg, reverse the behavior of
-`helm-moccur-always-search-in-current\\='.
+`helm-moccur-always-search-in-current'.
The prefix arg can be set before calling
-`helm-multi-occur-from-isearch\\=' or during the buffer selection.
+`helm-multi-occur-from-isearch' or during the buffer selection.
-To use this bind it to a key in `isearch-mode-map\\='."
+To use this bind it to a key in `isearch-mode-map'."
(interactive)
(let (buf-list
helm-moccur-always-search-in-current
diff --git a/helm-regexp.el b/helm-regexp.el
index bd7098b13c..eea6e671e0 100644
--- a/helm-regexp.el
+++ b/helm-regexp.el
@@ -35,9 +35,9 @@
(defvar helm-build-regexp-history nil)
(defun helm-query-replace-regexp (_candidate)
- "Query replace regexp from `helm-regexp\\='.
+ "Query replace regexp from `helm-regexp'.
With a prefix arg replace only matches surrounded by word boundaries,
-i.e. don\\='t replace inside a word, regexp is surrounded with \\bregexp\\b."
+i.e. don't replace inside a word, regexp is surrounded with \\bregexp\\b."
(let ((regexp helm-input))
(apply 'query-replace-regexp
(helm-query-replace-args regexp))))
@@ -48,11 +48,11 @@ i.e. don\\='t replace inside a word, regexp is surrounded
with \\bregexp\\b."
(prin1-to-string helm-input)))
(defun helm-kill-regexp (_candidate)
- "Kill regexp as it is in `helm-pattern\\='."
+ "Kill regexp as it is in `helm-pattern'."
(helm-regexp-kill-new helm-input))
(defun helm-query-replace-args (regexp)
- "Create arguments of `query-replace-regexp\\=' action in `helm-regexp\\='."
+ "Create arguments of `query-replace-regexp' action in `helm-regexp'."
(let ((region-only (helm-region-active-p)))
(list
regexp
@@ -114,7 +114,7 @@ i.e. don\\='t replace inside a word, regexp is surrounded
with \\bregexp\\b."
;;;###autoload
(defun helm-regexp ()
"Preconfigured helm to build regexps.
-`query-replace-regexp\\=' can be run from there against found regexp."
+`query-replace-regexp' can be run from there against found regexp."
(interactive)
(save-restriction
(when (and (helm-region-active-p)
diff --git a/helm-ring.el b/helm-ring.el
index c814adb429..6459ba39af 100644
--- a/helm-ring.el
+++ b/helm-ring.el
@@ -31,13 +31,13 @@
:group 'helm)
(defcustom helm-kill-ring-threshold 3
- "Minimum length of a candidate to be listed by `helm-source-kill-ring\\='."
+ "Minimum length of a candidate to be listed by `helm-source-kill-ring'."
:type 'integer
:group 'helm-ring)
(defcustom helm-kill-ring-max-offset 400
"Max number of chars displayed per candidate in kill-ring browser.
-When `t\\=', don\\='t truncate candidate, show all.
+When `t', don't truncate candidate, show all.
By default it is approximatively the number of bits contained in five lines
of 80 chars each, i.e. 80*5.
Note that if you set this to nil multiline will be disabled, i.e. you
@@ -78,7 +78,7 @@ will not have separators between candidates any more."
(define-key map (kbd "C-c C-k") 'helm-kill-ring-kill-selection)
(define-key map (kbd "C-c d") 'helm-kill-ring-run-persistent-delete)
map)
- "Keymap for `helm-show-kill-ring\\='.")
+ "Keymap for `helm-show-kill-ring'.")
(defvar helm-source-kill-ring
(helm-build-sync-source "Kill Ring"
@@ -131,7 +131,7 @@ will not have separators between candidates any more."
(defun helm-kill-ring-kill-selection ()
"Store the real value of candidate in kill-ring.
-Same as `helm-kill-selection-and-quit\\=' called with a prefix arg."
+Same as `helm-kill-selection-and-quit' called with a prefix arg."
(interactive)
(helm-kill-selection-and-quit t))
(put 'helm-kill-ring-kill-selection 'helm-only t)
@@ -152,7 +152,7 @@ Same as `helm-kill-selection-and-quit\\=' called with a
prefix arg."
"Insert concatenated marked candidates in current-buffer.
When two prefix args are given prompt to choose separator, otherwise
-use `helm-kill-ring-separator\\=' as default."
+use `helm-kill-ring-separator' as default."
(let ((marked (helm-marked-candidates))
(sep (if (equal helm-current-prefix-arg '(16))
(read-string "Separator: ")
@@ -163,11 +163,11 @@ use `helm-kill-ring-separator\\=' as default."
finally return (concat str (car (last marked)))))))
(defun helm-kill-ring-action-yank-1 (str)
- "Insert STR in `kill-ring\\=' and set STR to the head.
+ "Insert STR in `kill-ring' and set STR to the head.
When called with a prefix arg, point and mark are exchanged
without activating region.
-If this action is executed just after `yank\\=', replace with STR as
+If this action is executed just after `yank', replace with STR as
yanked string."
(let ((yank-fn (lambda (&optional before yank-pop)
(insert-for-yank str)
@@ -229,7 +229,7 @@ yanked string."
(put 'helm-kill-ring-run-search-from-string 'helm-only t)
(defun helm-kill-ring-action-delete (_candidate)
- "Delete marked candidates from `kill-ring\\='."
+ "Delete marked candidates from `kill-ring'."
(cl-loop for c in (helm-marked-candidates)
do (setq kill-ring
(delete c kill-ring))))
@@ -256,9 +256,9 @@ yanked string."
(put 'helm-kill-ring-run-persistent-delete 'helm-only t)
(defun helm-kill-ring-delete ()
- "Delete marked candidates from `kill-ring\\='.
+ "Delete marked candidates from `kill-ring'.
-This is a command for `helm-kill-ring-map\\='."
+This is a command for `helm-kill-ring-map'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action 'helm-kill-ring-action-delete)))
@@ -479,7 +479,7 @@ This is a command for `helm-kill-ring-map\\='."
;;;###autoload
(defun helm-mark-ring ()
- "Preconfigured `helm\\=' for `helm-source-mark-ring\\='."
+ "Preconfigured `helm' for `helm-source-mark-ring'."
(interactive)
(helm :sources 'helm-source-mark-ring
:resume 'noresume
@@ -487,7 +487,7 @@ This is a command for `helm-kill-ring-map\\='."
;;;###autoload
(defun helm-global-mark-ring ()
- "Preconfigured `helm\\=' for `helm-source-global-mark-ring\\='."
+ "Preconfigured `helm' for `helm-source-global-mark-ring'."
(interactive)
(helm :sources 'helm-source-global-mark-ring
:resume 'noresume
@@ -495,9 +495,9 @@ This is a command for `helm-kill-ring-map\\='."
;;;###autoload
(defun helm-all-mark-rings ()
- "Preconfigured `helm\\=' for mark rings.
-Source used are `helm-source-global-mark-ring\\=' and
-`helm-source-mark-ring\\='."
+ "Preconfigured `helm' for mark rings.
+Source used are `helm-source-global-mark-ring' and
+`helm-source-mark-ring'."
(interactive)
(helm :sources '(helm-source-mark-ring
helm-source-global-mark-ring)
@@ -506,7 +506,7 @@ Source used are `helm-source-global-mark-ring\\=' and
;;;###autoload
(defun helm-register ()
- "Preconfigured `helm\\=' for Emacs registers."
+ "Preconfigured `helm' for Emacs registers."
(interactive)
(helm :sources 'helm-source-register
:resume 'noresume
@@ -514,8 +514,8 @@ Source used are `helm-source-global-mark-ring\\=' and
;;;###autoload
(defun helm-show-kill-ring ()
- "Preconfigured `helm\\=' for `kill-ring\\='.
-It is drop-in replacement of `yank-pop\\='.
+ "Preconfigured `helm' for `kill-ring'.
+It is drop-in replacement of `yank-pop'.
First call open the kill-ring browser, next calls move to next line."
(interactive)
@@ -529,7 +529,7 @@ First call open the kill-ring browser, next calls move to
next line."
;;;###autoload
(defun helm-execute-kmacro ()
"Preconfigured helm for keyboard macros.
-Define your macros with `f3\\=' and `f4\\='.
+Define your macros with `f3' and `f4'.
See (info \"(emacs) Keyboard Macros\") for detailed infos.
This command is useful when used with persistent action."
(interactive)
diff --git a/helm-semantic.el b/helm-semantic.el
index 8cb14cc630..4687029443 100644
--- a/helm-semantic.el
+++ b/helm-semantic.el
@@ -39,19 +39,19 @@
'((python-mode . semantic-format-tag-summarize)
(c-mode . semantic-format-tag-concise-prototype-c-mode)
(emacs-lisp-mode . semantic-format-tag-abbreviate-emacs-lisp-mode))
- "Function to present a semantic tag according to `major-mode\\='.
+ "Function to present a semantic tag according to `major-mode'.
-It is an alist where the `car\\=' of each element is a `major-mode\\=' and
-the `cdr\\=' a `semantic-format-tag-*\\=' function.
+It is an alist where the `car' of each element is a `major-mode' and
+the `cdr' a `semantic-format-tag-*' function.
-If no function is found for current `major-mode\\=', fall back to
-`semantic-format-tag-summarize\\=' default function.
+If no function is found for current `major-mode', fall back to
+`semantic-format-tag-summarize' default function.
-You can have more or less informations depending of the
`semantic-format-tag-*\\='
+You can have more or less informations depending of the `semantic-format-tag-*'
function you choose.
All the supported functions are prefixed with \"semantic-format-tag-\",
-you have completion on these functions with `C-M i\\=' in the customize
interface."
+you have completion on these functions with `C-M i' in the customize
interface."
:group 'helm-semantic
:type '(alist :key-type symbol :value-type symbol))
@@ -153,7 +153,7 @@ you have completion on these functions with `C-M i\\=' in
the customize interfac
(action :initform 'helm-semantic-default-action)))
(defcustom helm-semantic-fuzzy-match nil
- "Enable fuzzy matching in `helm-source-semantic\\='."
+ "Enable fuzzy matching in `helm-source-semantic'."
:group 'helm-semantic
:type 'boolean
:set (lambda (var val)
@@ -164,7 +164,7 @@ you have completion on these functions with `C-M i\\=' in
the customize interfac
;;;###autoload
(defun helm-semantic (arg)
- "Preconfigured `helm\\=' for `semantic\\='.
+ "Preconfigured `helm' for `semantic'.
If ARG is supplied, pre-select symbol at point instead of current."
(interactive "P")
(let ((tag (helm-aif (car (semantic-current-tag-parent))
@@ -188,12 +188,12 @@ If ARG is supplied, pre-select symbol at point instead of
current."
;;;###autoload
(defun helm-semantic-or-imenu (arg)
- "Preconfigured helm for `semantic\\=' or `imenu\\='.
+ "Preconfigured helm for `semantic' or `imenu'.
If ARG is supplied, pre-select symbol at point instead of current
semantic tag in scope.
-If `semantic-mode\\=' is active in the current buffer, then use
-semantic for generating tags, otherwise fall back to `imenu\\='.
+If `semantic-mode' is active in the current buffer, then use
+semantic for generating tags, otherwise fall back to `imenu'.
Fill in the symbol at point by default."
(interactive "P")
(unless helm-source-semantic
diff --git a/helm-source.el b/helm-source.el
index b8791e9bc5..8516cec88f 100644
--- a/helm-source.el
+++ b/helm-source.el
@@ -45,7 +45,7 @@
;; unnecessary crap.
(defun helm-source--cl--print-table (&rest args)
- "Advice for `cl--print-table\\=' to make readable class slots docstrings."
+ "Advice for `cl--print-table' to make readable class slots docstrings."
(cl-flet ((print-rows (rows)
(let ((format "%s\n\n Initform=%s\n\n%s"))
(dolist (row rows)
@@ -82,7 +82,7 @@
" A function returning the display string of the header.
Its argument is the name of the source. This attribute is useful to
add an additional information with the source name.
- It doesn\\='t modify the name of the source.")
+ It doesn't modify the name of the source.")
(init
:initarg :init
@@ -92,8 +92,8 @@
" Function called with no parameters when helm is started.
It is useful for collecting current state information which can be
used to create the list of candidates later.
- Initialization of `candidates-in-buffer\\=' is done here
- with `helm-init-candidates-in-buffer\\='.")
+ Initialization of `candidates-in-buffer' is done here
+ with `helm-init-candidates-in-buffer'.")
(candidates
:initarg :candidates
@@ -104,7 +104,7 @@
It can either be a variable name, a function called with no parameters
or the actual list of candidates.
- Do NOT use this for asynchronous sources, use `candidates-process\\='
+ Do NOT use this for asynchronous sources, use `candidates-process'
instead.
The list must be a list whose members are strings, symbols
@@ -123,7 +123,7 @@
value.
This function, generally should not compute candidates according to
- `helm-pattern\\=' which defeat all the Helm\\='s matching mechanism
+ `helm-pattern' which defeat all the Helm's matching mechanism
i.e. multiple pattern matching and/or fuzzy matching.
If you want to do so, use :match-dynamic slot to be sure matching
occur only in :candidates function and there is no conflict with
@@ -135,7 +135,7 @@
:custom function
:documentation
" Function called with no parameters at before \"init\" function
- when `helm-force-update\\=' is called.")
+ when `helm-force-update' is called.")
(cleanup
:initarg :cleanup
@@ -153,7 +153,7 @@
:custom sexp
:documentation
" Specific keymap for this source.
- default value is `helm-map\\='.")
+ default value is `helm-map'.")
(action
:initarg :action
@@ -170,7 +170,7 @@
buffer and the FUNCTION is invoked when an action is
selected. The first action of the list is the default.
- You should use `helm-make-actions\\=' to build this alist easily.")
+ You should use `helm-make-actions' to build this alist easily.")
(persistent-action
:initarg :persistent-action
@@ -180,35 +180,35 @@
" Can be a either a Function called with one parameter (the
selected candidate) or a cons cell where first element is this
same function and second element a symbol (e.g never-split)
- that inform `helm-execute-persistent-action\\=' to not split his
+ that inform `helm-execute-persistent-action' to not split his
window to execute this persistent action.
Example:
(defun foo-persistent-action (candidate)
(do-something candidate))
- :persistent-action \\='(foo-persistent-action . never-split) ; Don\\='t
split
+ :persistent-action '(foo-persistent-action . never-split) ; Don't split
or
- :persistent-action \\='foo-persistent-action ; Split
+ :persistent-action 'foo-persistent-action ; Split
When specifying :persistent-action by slot directly, foo-persistent-action
- will be executed without quitting helm when hitting `C-j\\='.
+ will be executed without quitting helm when hitting `C-j'.
Note that other persistent actions can be defined using other
- bindings than `C-j\\=' by simply defining an interactive function bound
+ bindings than `C-j' by simply defining an interactive function bound
to a key in the keymap source.
The function should create a new attribute in source before calling
- `helm-execute-persistent-action\\=' on this attribute.
+ `helm-execute-persistent-action' on this attribute.
Example:
(defun helm-ff-persistent-delete ()
\"Delete current candidate without quitting.\"
(interactive)
(with-helm-alive-p
- (helm-set-attr \\='quick-delete \\='(helm-ff-quick-delete .
never-split))
- (helm-execute-persistent-action \\='quick-delete)))
+ (helm-set-attr 'quick-delete '(helm-ff-quick-delete . never-split))
+ (helm-execute-persistent-action 'quick-delete)))
- This function is then bound in `helm-find-files-map\\='.")
+ This function is then bound in `helm-find-files-map'.")
(persistent-action-if
:initarg :persistent-action-if
@@ -222,21 +222,21 @@
(defun foo-persistent-action (candidate)
(cond (something
- ;; Don\\='t split helm-window.
+ ;; Don't split helm-window.
(cons (lambda (_ignore)
(do-something candidate))
- \\='no-split))
+ 'no-split))
;; Split helm-window.
(something-else
(lambda (_ignore)
(do-something-else candidate)))))
- :persistent-action-if \\='foo-persistent-action
+ :persistent-action-if 'foo-persistent-action
- Here when hitting `C-j\\=' one of the lambda\\='s will be executed
+ Here when hitting `C-j' one of the lambda's will be executed
depending on something or something-else condition, splitting or not
splitting as needed.
- See `helm-find-files-persistent-action-if\\=' definition as another
example.")
+ See `helm-find-files-persistent-action-if' definition as another example.")
(persistent-help
:initarg :persistent-help
@@ -245,11 +245,11 @@
:documentation
" A string to explain persistent-action of this source.
It is a facility to display what persistent action does in
- header-line, once your source is loaded don\\='t use it directly, it will
- have no effect, use instead `header-line\\=' attribute.
+ header-line, once your source is loaded don't use it directly, it will
+ have no effect, use instead `header-line' attribute.
It also accepts a function or a variable name.
- It will be displayed in `header-line\\=' or in `minibuffer\\=' depending
- of value of `helm-echo-input-in-header-line\\=' and
`helm-display-header-line\\='.")
+ It will be displayed in `header-line' or in `minibuffer' depending
+ of value of `helm-echo-input-in-header-line' and
`helm-display-header-line'.")
(help-message
:initarg :help-message
@@ -257,7 +257,7 @@
:custom (choice string function)
:documentation
" Help message for this source.
- If not present, `helm-help-message\\=' value will be used.")
+ If not present, `helm-help-message' value will be used.")
(multiline
:initarg :multiline
@@ -265,8 +265,8 @@
:custom (choice boolean integer)
:documentation
" Allow multiline candidates.
- When non-nil candidates will be separated by `helm-candidate-separator\\='.
- You can customize the color of this separator with `helm-separator\\=' face.
+ When non-nil candidates will be separated by `helm-candidate-separator'.
+ You can customize the color of this separator with `helm-separator' face.
Value of multiline can be an integer which specify the maximum size of the
multiline string to display, if multiline string is longer than this value
it will be truncated.")
@@ -286,7 +286,7 @@
:initform nil
:custom (choice function list)
:documentation
- " It\\='s a function or a list of functions called with one argument
+ " It's a function or a list of functions called with one argument
when the completion list from the source is built. The argument
is the list of candidates retrieved from the source. The
function should return a transformed list of candidates which
@@ -296,7 +296,7 @@
This can be used to transform or remove items from the list of
candidates.
- Note that `candidates\\=' is run already, so the given transformer
+ Note that `candidates' is run already, so the given transformer
function should also be able to handle candidates with (DISPLAY
. REAL) format.")
@@ -305,12 +305,12 @@
:initform nil
:custom (choice function list)
:documentation
- " It has the same format as `candidate-transformer\\=', except the
+ " It has the same format as `candidate-transformer', except the
function is called with two parameters: the candidate list and
the source.
This transformer is run on the candidate list which is already
- filtered by the current pattern. While `candidate-transformer\\='
+ filtered by the current pattern. While `candidate-transformer'
is run only once, it is run every time the input pattern is
changed.
@@ -318,14 +318,14 @@
example, based on the current pattern.
In some cases it may also be more efficent to perform candidate
- transformation here, instead of with `candidate-transformer\\='
+ transformation here, instead of with `candidate-transformer'
even if this transformation is done every time the pattern is
changed. For example, if a candidate set is very large then
- `candidate-transformer\\=' transforms every candidate while only
+ `candidate-transformer' transforms every candidate while only
some of them will actually be displayed due to the limit
- imposed by `helm-candidate-number-limit\\='.
+ imposed by `helm-candidate-number-limit'.
- Note that `candidates\\=' and `candidate-transformer\\=' is run
+ Note that `candidates' and `candidate-transformer' is run
already, so the given transformer function should also be able
to handle candidates with (DISPLAY . REAL) format.")
@@ -336,14 +336,14 @@
:documentation
" A transformer function that treat candidates one by one.
It is called with one arg the candidate.
- It is faster than `filtered-candidate-transformer\\=' or
- `candidate-transformer\\=', but should be used only in sources
- that recompute constantly their candidates, e.g `helm-source-find-files\\='.
+ It is faster than `filtered-candidate-transformer' or
+ `candidate-transformer', but should be used only in sources
+ that recompute constantly their candidates, e.g `helm-source-find-files'.
Filtering happen early and candidates are treated
one by one instead of re-looping on the whole list.
- If used with `filtered-candidate-transformer\\=' or
`candidate-transformer\\='
+ If used with `filtered-candidate-transformer' or `candidate-transformer'
these functions should treat the candidates transformed by the
- `filter-one-by-one\\=' function in consequence.")
+ `filter-one-by-one' function in consequence.")
(display-to-real
:initarg :display-to-real
@@ -363,7 +363,7 @@
Example:
(helm :sources (helm-build-sync-source \"test\"
- :candidates \\='(a b c d e)
+ :candidates '(a b c d e)
:display-to-real (lambda (c) (concat c \":modified by
d-t-r\")))
:buffer \"*helm test*\")
@@ -384,7 +384,7 @@
Example:
(helm :sources (helm-build-sync-source \"test\"
- :candidates \\='((\"foo\" . 1) (\"bar\" . 2) (\"baz\". 3))
+ :candidates '((\"foo\" . 1) (\"bar\" . 2) (\"baz\". 3))
:real-to-display (lambda (c) (format \"%s\" (1+ c))))
:buffer \"*helm test*\")
@@ -395,16 +395,16 @@
:initform nil
:custom (choice boolean symbol)
:documentation
- " Get candidates with their properties in `helm-marked-candidates\\='.
- Allow using the FORCE-DISPLAY-PART of `helm-get-selection\\=' in marked
- candidates, use t or \\='withprop to pass it to `helm-get-selection\\='.")
+ " Get candidates with their properties in `helm-marked-candidates'.
+ Allow using the FORCE-DISPLAY-PART of `helm-get-selection' in marked
+ candidates, use t or 'withprop to pass it to `helm-get-selection'.")
(action-transformer
:initarg :action-transformer
:initform nil
:custom (choice function list)
:documentation
- " It\\='s a function or a list of functions called with two
+ " It's a function or a list of functions called with two
arguments when the action list from the source is
assembled. The first argument is the list of actions, the
second is the current selection. If it is a list of functions,
@@ -420,18 +420,18 @@
:initform nil
:custom (choice function list)
:documentation
- " It\\='s a function or a list of functions called with one argument
- before computing matches. Its argument is `helm-pattern\\='.
- Functions should return transformed `helm-pattern\\='.
+ " It's a function or a list of functions called with one argument
+ before computing matches. Its argument is `helm-pattern'.
+ Functions should return transformed `helm-pattern'.
- It is useful to change interpretation of `helm-pattern\\='.")
+ It is useful to change interpretation of `helm-pattern'.")
(candidate-number-limit
:initarg :candidate-number-limit
:initform nil
:custom integer
:documentation
- " Override `helm-candidate-number-limit\\=' only for this source.")
+ " Override `helm-candidate-number-limit' only for this source.")
(volatile
:initarg :volatile
@@ -439,7 +439,7 @@
:custom boolean
:documentation
" Indicates the source assembles the candidate list dynamically,
- so it shouldn\\='t be cached within a single Helm
+ so it shouldn't be cached within a single Helm
invocation. It is only applicable to synchronous sources,
because asynchronous sources are not cached.")
@@ -450,15 +450,15 @@
:documentation
" List of functions called with one parameter: a candidate. The
function should return non-nil if the candidate matches the
- current pattern (see variable `helm-pattern\\=').
+ current pattern (see variable `helm-pattern').
- When using `candidates-in-buffer\\=' its default value is `identity\\=' and
- don\\='t have to be changed, use the `search\\=' slot instead.
+ When using `candidates-in-buffer' its default value is `identity' and
+ don't have to be changed, use the `search' slot instead.
This attribute allows the source to override the default
- pattern matching based on `string-match\\='. It can be used, for
+ pattern matching based on `string-match'. It can be used, for
example, to implement a source for file names and do the
- pattern matching on the basename of files, since it\\='s more
+ pattern matching on the basename of files, since it's more
likely one is typing part of the basename when searching for a
file, instead of some string anywhere else in its path.
@@ -471,7 +471,7 @@
functions, respectively.
This attribute has no effect for asynchronous sources (see
- attribute `candidates\\='), and sources using `match-dynamic\\='
+ attribute `candidates'), and sources using `match-dynamic'
since they perform pattern matching themselves.
Note that FUZZY-MATCH slot will overhide value of this slot.")
@@ -497,10 +497,10 @@
:documentation
" Enable fuzzy matching in this source.
This will overwrite settings in MATCH slot, and for
- sources built with child class `helm-source-in-buffer\\=' the SEARCH slot.
+ sources built with child class `helm-source-in-buffer' the SEARCH slot.
This is an easy way of enabling fuzzy matching, but you can use the MATCH
or SEARCH slots yourself if you want something more elaborated, mixing
- different type of match (See `helm-source-buffers\\=' class for example).
+ different type of match (See `helm-source-buffers' class for example).
This attribute is not supported for asynchronous sources
since they perform pattern matching themselves.")
@@ -511,10 +511,10 @@
:custom (choice list function)
:documentation
" A function or a list of functions to apply to current list
- of candidates when redisplaying buffer with `helm-redisplay-buffer\\='.
+ of candidates when redisplaying buffer with `helm-redisplay-buffer'.
This is only interesting for modifying and redisplaying the whole list
of candidates in async sources.
- It uses `identity\\=' by default for when async sources are mixed with
+ It uses `identity' by default for when async sources are mixed with
normal sources, in this case these normal sources are not modified and
redisplayed as they are.")
@@ -523,7 +523,7 @@
:initform nil
:custom boolean
:documentation
- " Don\\='t allow marking candidates when this attribute is present.")
+ " Don't allow marking candidates when this attribute is present.")
(nohighlight
:initarg :nohighlight
@@ -533,13 +533,13 @@
" Disable highlighting matches in this source.
This will disable generic highlighting of matches,
but some specialized highlighting can be done from elsewhere,
- i.e from `filtered-candidate-transformer\\=' or `filter-one-by-one\\=' slots.
+ i.e from `filtered-candidate-transformer' or `filter-one-by-one' slots.
So use this to either disable completely highlighting in your source,
or to disable highlighting and use a specialized highlighting matches
function for this source.
Remember that this function should run AFTER all filter functions if those
filter functions are modifying face properties, though it is possible to
- avoid this by using new `add-face-text-property\\=' in your filter
functions.")
+ avoid this by using new `add-face-text-property' in your filter functions.")
(allow-dups
:initarg :allow-dups
@@ -556,7 +556,7 @@
" Allow passing history variable to helm from source.
It should be a quoted symbol.
Passing the history variable here have no effect
- so add it also in the `helm\\=' call with the :history keyword.
+ so add it also in the `helm' call with the :history keyword.
The main point of adding the variable here
is to make it available when resuming.")
@@ -565,7 +565,7 @@
:initform nil
:custom function
:documentation
- " It\\='s a function called with one argument: the selected candidate.
+ " It's a function called with one argument: the selected candidate.
This function is intended for type convertion. In normal case,
the selected candidate (string) is passed to action
function. If coerce function is specified, it is called just
@@ -579,17 +579,17 @@
:initform nil
:custom (choice string sexp)
:documentation
- " Source local `helm-mode-line-string\\=' (included in
- `mode-line-format\\='). It accepts also variable/function name.")
+ " Source local `helm-mode-line-string' (included in
+ `mode-line-format'). It accepts also variable/function name.")
(header-line
:initarg :header-line
:initform nil
:custom (choice string function)
:documentation
- " Source local `header-line-format\\='.
- It will be displayed in `header-line\\=' or in `minibuffer\\=' depending
- of value of `helm-echo-input-in-header-line\\=' and
`helm-display-header-line\\='.
+ " Source local `header-line-format'.
+ It will be displayed in `header-line' or in `minibuffer' depending
+ of value of `helm-echo-input-in-header-line' and `helm-display-header-line'.
It accepts also variable/function name.")
(resume
@@ -598,28 +598,28 @@
:custom function
:documentation
" Function called with no parameters at end of initialization
- when `helm-resume\\=' is started.
- If this function try to do something against `helm-buffer\\=', (e.g updating,
- searching etc...) probably you should run it in a timer to ensure
- `helm-buffer\\=' is ready.")
+ when `helm-resume' is started.
+ If this function try to do something against `helm-buffer', \(e.g updating,
+ searching etc...\) probably you should run it in a timer to ensure
+ `helm-buffer' is ready.")
(follow
:initarg :follow
:initform nil
:custom integer
:documentation
- " Enable `helm-follow-mode\\=' for this source only.
+ " Enable `helm-follow-mode' for this source only.
With a value of 1 enable, a value of -1 or nil disable the mode.
- See `helm-follow-mode\\=' for more infos.")
+ See `helm-follow-mode' for more infos.")
(follow-delay
:initarg :follow-delay
:initform nil
:custom integer
:documentation
- " `helm-follow-mode\\=' will execute persistent-action after this delay.
- Otherwise value of `helm-follow-input-idle-delay\\=' is used if non--nil,
- If none of these are found fallback to `helm-input-idle-delay\\='.")
+ " `helm-follow-mode' will execute persistent-action after this delay.
+ Otherwise value of `helm-follow-input-idle-delay' is used if non--nil,
+ If none of these are found fallback to `helm-input-idle-delay'.")
(multimatch
:initarg :multimatch
@@ -653,7 +653,7 @@
:custom symbol
:documentation
" A local hook that run at beginning of initilization of this source.
- i.e Before the creation of `helm-buffer\\='.
+ i.e Before the creation of `helm-buffer'.
Should be a variable (defined with defvar).
Can be also an anonymous function or a list of functions
@@ -665,7 +665,7 @@
:custom symbol
:documentation
" A local hook that run at end of initilization of this source.
- i.e After the creation of `helm-buffer\\='.
+ i.e After the creation of `helm-buffer'.
Should be a variable.
Can be also an anonymous function or a list of functions
@@ -677,21 +677,21 @@
:custom (choice null integer)
:documentation
" This slot have no more effect and is just kept for backward
compatibility.
- Please don\\='t use it.")
+ Please don't use it.")
(must-match
:initarg :must-match
:initform nil
:custom symbol
:documentation
- " Same as `completing-read\\=' require-match arg.
+ " Same as `completing-read' require-match arg.
Possible values are:
- - `t\\=' which prevent exiting with an empty helm-buffer i.e. no matches.
- - `confirm\\=' which ask for confirmation i.e. need to press a second
+ - `t' which prevent exiting with an empty helm-buffer i.e. no matches.
+ - `confirm' which ask for confirmation i.e. need to press a second
time RET.
- - `nil\\=' is the default and is doing nothing i.e. returns nil when
+ - `nil' is the default and is doing nothing i.e. returns nil when
pressing RET with an empty helm-buffer.
- - Any other non nil values e.g. `ignore\\=' allow exiting with
+ - Any other non nil values e.g. `ignore' allow exiting with
minibuffer contents as candidate value (in this case helm-buffer
is empty).")
@@ -700,7 +700,7 @@
:initform nil
:custom function
:documentation
- " Determine the target file when running `helm-quit-and-find-file\\='.
+ " Determine the target file when running `helm-quit-and-find-file'.
It is a function called with one arg SOURCE.")
(group
@@ -708,7 +708,7 @@
:initform 'helm
:custom symbol
:documentation
- " The current source group, default to `helm\\=' when not specified."))
+ " The current source group, default to `helm' when not specified."))
"Main interface to define helm sources."
:abstract t)
@@ -723,11 +723,11 @@
:custom boolean
:documentation
" Enable migemo.
- When multimatch is disabled, you can give the symbol \\='nomultimatch as
value
+ When multimatch is disabled, you can give the symbol 'nomultimatch as value
to force not using generic migemo matching function.
In this case you have to provide your own migemo matching funtion
- that kick in when `helm-migemo-mode\\=' is enabled.
- Otherwise it will be available for this source once `helm-migemo-mode\\='
+ that kick in when `helm-migemo-mode' is enabled.
+ Otherwise it will be available for this source once `helm-migemo-mode'
is enabled when non-nil.")
(match-strict
@@ -738,7 +738,7 @@
" When specifying a match function within a source and
helm-multi-match is enabled, the result of all matching
functions will be concatened, which in some cases is not what
- is wanted. When using `match-strict\\=' only this or these
+ is wanted. When using `match-strict' only this or these
functions will be used. You can specify those functions as a
list of functions or a single symbol function.
@@ -751,14 +751,14 @@
:documentation
" Disable all helm matching functions when non nil.
The :candidates function in this case is in charge of fetching
- candidates dynamically according to `helm-pattern\\='.
+ candidates dynamically according to `helm-pattern'.
Note that :volatile is automatically enabled when using this, so no
need to specify it."))
"Use this class to make helm sources using a list of candidates.
This list should be given as a normal list, a variable handling a list
or a function returning a list.
-Matching is done basically with `string-match\\=' against each candidate.")
+Matching is done basically with `string-match' against each candidate.")
(defclass helm-source-async (helm-source)
((candidates-process
@@ -768,7 +768,7 @@ Matching is done basically with `string-match\\=' against
each candidate.")
:documentation
" This attribute is used to define a process as candidate.
The function called with no arguments must return a process
- i.e. `processp\\=', it use typically `start-process\\=' or `make-process\\=',
+ i.e. `processp', it use typically `start-process' or `make-process',
see (info \"(elisp) Asynchronous Processes\").
@@ -776,19 +776,19 @@ Matching is done basically with `string-match\\=' against
each candidate.")
When building the source at runtime you can give directly a process
as value, otherwise wrap the process call into a function.
The process buffer should be nil, otherwise, if you use
- `helm-buffer\\=' give to the process a sentinel.")
+ `helm-buffer' give to the process a sentinel.")
(multimatch :initform nil))
"Use this class to define a helm source calling an external process.
-The external process is called typically in a `start-process\\=' call to be
+The external process is called typically in a `start-process' call to be
asynchronous.
Note that using multiples asynchronous sources is not fully working,
expect weird behavior if you try this.
The :candidates slot is not allowed even if described because this class
-inherit from `helm-source\\='.")
+inherit from `helm-source'.")
(defclass helm-source-in-buffer (helm-source)
((init
@@ -799,11 +799,11 @@ inherit from `helm-source\\='.")
:initform nil
:custom (choice list string)
:documentation
- " A string, a list or a buffer that will be used to feed the
`helm-candidates-buffer\\='.
+ " A string, a list or a buffer that will be used to feed the
`helm-candidates-buffer'.
This data will be passed in a function added to the init slot and
- the buffer will be build with `helm-init-candidates-in-buffer\\=' or directly
- with `helm-candidates-buffer\\=' if data is a buffer.
- This is an easy and fast method to build a `candidates-in-buffer\\='
source.")
+ the buffer will be build with `helm-init-candidates-in-buffer' or directly
+ with `helm-candidates-buffer' if data is a buffer.
+ This is an easy and fast method to build a `candidates-in-buffer' source.")
(migemo
:initarg :migemo
@@ -811,11 +811,11 @@ inherit from `helm-source\\='.")
:custom boolean
:documentation
" Enable migemo.
- When multimatch is disabled, you can give the symbol \\='nomultimatch as
value
+ When multimatch is disabled, you can give the symbol 'nomultimatch as value
to force not using generic migemo matching function.
In this case you have to provide your own migemo matching funtion
- that kick in when `helm-migemo-mode\\=' is enabled.
- Otherwise it will be available for this source once `helm-migemo-mode\\='
+ that kick in when `helm-migemo-mode' is enabled.
+ Otherwise it will be available for this source once `helm-migemo-mode'
is enabled when non-nil.")
(candidates
@@ -832,12 +832,12 @@ inherit from `helm-source\\='.")
:initform 'buffer-substring-no-properties
:custom function
:documentation
- " A function like `buffer-substring-no-properties\\=' or
`buffer-substring\\='.
+ " A function like `buffer-substring-no-properties' or `buffer-substring'.
This function converts region from point at line-beginning and point
- at line-end in the `helm-candidate-buffer\\=' to a string which will be
displayed
- in the `helm-buffer\\=', it takes two args BEG and END.
- By default, `helm-candidates-in-buffer\\=' uses
- `buffer-substring-no-properties\\=' which does no conversion and doesn\\='t
carry
+ at line-end in the `helm-candidate-buffer' to a string which will be
displayed
+ in the `helm-buffer', it takes two args BEG and END.
+ By default, `helm-candidates-in-buffer' uses
+ `buffer-substring-no-properties' which does no conversion and doesn't carry
text properties.")
(search
@@ -845,15 +845,15 @@ inherit from `helm-source\\='.")
:initform '(helm-candidates-in-buffer-search-default-fn)
:custom (choice function list)
:documentation
- " List of functions like `re-search-forward\\=' or `search-forward\\='.
- Buffer search function used by `helm-candidates-in-buffer\\='.
- By default, `helm-candidates-in-buffer\\=' uses `re-search-forward\\='.
+ " List of functions like `re-search-forward' or `search-forward'.
+ Buffer search function used by `helm-candidates-in-buffer'.
+ By default, `helm-candidates-in-buffer' uses `re-search-forward'.
The function should take one arg PATTERN.
If your search function needs to handle negation like multimatch,
this function should returns in such case a cons cell of two integers
defining
the beg and end positions to match in the line previously matched by
- `re-search-forward\\=' or similar, and move point to next line
- (See how the `helm-mm-3-search-base\\=' and `helm-fuzzy-search\\=' functions
are working).
+ `re-search-forward' or similar, and move point to next line
+ (See how the `helm-mm-3-search-base' and `helm-fuzzy-search' functions are
working).
NOTE: FUZZY-MATCH slot will overhide value of this slot.")
@@ -865,7 +865,7 @@ inherit from `helm-source\\='.")
" When specifying a search function within a source and
helm-multi-match is enabled, the result of all searching
functions will be concatened, which in some cases is not what
- is wanted. When using `search-strict\\=' only this or these
+ is wanted. When using `search-strict' only this or these
functions will be used. You can specify those functions as a
list of functions or a single symbol function.
@@ -874,15 +874,15 @@ inherit from `helm-source\\='.")
"Use this source to make helm sources storing candidates inside a buffer.
-The buffer storing candidates is generated by `helm-candidate-buffer\\='
function
-and all search are done in this buffer, results are transfered to the
`helm-buffer\\='
+The buffer storing candidates is generated by `helm-candidate-buffer' function
+and all search are done in this buffer, results are transfered to the
`helm-buffer'
when done.
-Contrarily to `helm-source-sync\\=' candidates are matched using a function
-like `re-search-forward\\=' (see below documentation of `:search\\=' slot)
which makes
+Contrarily to `helm-source-sync' candidates are matched using a function
+like `re-search-forward' (see below documentation of `:search' slot) which
makes
the search much faster than matching candidates one by one.
-If you want to add search functions to your sources, don\\='t use `:match\\='
which
-will raise an error, but `:search\\='.
-See `helm-candidates-in-buffer\\=' for more infos.")
+If you want to add search functions to your sources, don't use `:match' which
+will raise an error, but `:search'.
+See `helm-candidates-in-buffer' for more infos.")
(defclass helm-source-dummy (helm-source)
((candidates
@@ -934,7 +934,7 @@ See `helm-candidates-in-buffer\\=' for more infos.")
:initform nil
:documentation
" Store line number in each candidate when non nil.
- Line number is stored in `helm-linum\\=' text property."))
+ Line number is stored in `helm-linum' text property."))
"The contents of the FILE will be used as candidates in buffer.")
@@ -960,7 +960,7 @@ Where OBJECT is an instance of an eieio class."
collect (cons s slot-val)))
(defun helm-make-source (name class &rest args)
- "Build a `helm\\=' source named NAME with ARGS for CLASS.
+ "Build a `helm' source named NAME with ARGS for CLASS.
Argument NAME is a string which define the source name, so no need to use
the keyword :name in your source, NAME will be used instead.
Argument CLASS is an eieio class object.
@@ -983,8 +983,8 @@ Arguments ARGS are keyword value pairs as defined in CLASS."
(defun helm-source-mm-get-search-or-match-fns (source method)
"Prepare match or search functions for class SOURCE.
-Argument METHOD is the matching method used by SOURCE either `match\\='
-or `search\\='."
+Argument METHOD is the matching method used by SOURCE either `match'
+or `search'."
(let* ((diacritics (slot-value source 'diacritics))
(defmatch (helm-aif (slot-value source 'match)
(helm-mklist it)))
@@ -1036,8 +1036,8 @@ or `search\\='."
;;
(cl-defun helm-source-add-action-to-source-if (name fn source predicate
&optional (index 4))
- "Same as `helm-add-action-to-source-if\\=' but for SOURCE defined as eieio
object.
-You can use this inside a `helm--setup-source\\=' method for a SOURCE defined
as
+ "Same as `helm-add-action-to-source-if' but for SOURCE defined as eieio
object.
+You can use this inside a `helm--setup-source' method for a SOURCE defined as
an eieio class."
(let* ((actions (slot-value source 'action))
(action-transformers (slot-value source 'action-transformer))
@@ -1061,7 +1061,7 @@ an eieio class."
;;
;;
(defun helm-source--persistent-help-string (value source)
- "Format `persistent-help\\=' VALUE in SOURCE.
+ "Format `persistent-help' VALUE in SOURCE.
Argument VALUE can be a string, a variable or a function."
(substitute-command-keys
(format "\\<helm-map>\\[helm-execute-persistent-action]: %s (keeping
session)"
@@ -1072,8 +1072,8 @@ Argument VALUE can be a string, a variable or a function."
(defun helm-source--header-line (source)
"Compute a default header line for SOURCE.
-The header line is based on one of `persistent-action-if\\=',
-`persistent-action\\=', or `action\\=' (in this order of precedence)."
+The header line is based on one of `persistent-action-if',
+`persistent-action', or `action' (in this order of precedence)."
(substitute-command-keys
(concat "\\<helm-map>\\[helm-execute-persistent-action]: "
(helm-acond
@@ -1251,33 +1251,33 @@ The header line is based on one of
`persistent-action-if\\=',
;; Sources
(defmacro helm-build-sync-source (name &rest args)
"Build a synchronous helm source with name NAME.
-Args ARGS are keywords provided by `helm-source-sync\\='."
+Args ARGS are keywords provided by `helm-source-sync'."
(declare (indent 1))
`(helm-make-source ,name 'helm-source-sync ,@args))
(defmacro helm-build-async-source (name &rest args)
"Build a asynchronous helm source with name NAME.
-Args ARGS are keywords provided by `helm-source-async\\='."
+Args ARGS are keywords provided by `helm-source-async'."
(declare (indent 1))
`(helm-make-source ,name 'helm-source-async ,@args))
(defmacro helm-build-in-buffer-source (name &rest args)
- "Build a helm source with name NAME using `candidates-in-buffer\\=' method.
-Args ARGS are keywords provided by `helm-source-in-buffer\\='."
+ "Build a helm source with name NAME using `candidates-in-buffer' method.
+Args ARGS are keywords provided by `helm-source-in-buffer'."
(declare (indent 1))
`(helm-make-source ,name 'helm-source-in-buffer ,@args))
(defmacro helm-build-dummy-source (name &rest args)
- "Build a helm source with name NAME using `dummy\\=' method.
-Args ARGS are keywords provided by `helm-source-dummy\\='."
+ "Build a helm source with name NAME using `dummy' method.
+Args ARGS are keywords provided by `helm-source-dummy'."
(declare (indent 1))
`(helm-make-source ,name 'helm-source-dummy ,@args))
(defmacro helm-build-in-file-source (name file &rest args)
- "Build a helm source with NAME name using `candidates-in-files\\=' method.
+ "Build a helm source with NAME name using `candidates-in-files' method.
Arg FILE is a filename, the contents of this file will be
used as candidates in buffer.
-Args ARGS are keywords provided by `helm-source-in-file\\='."
+Args ARGS are keywords provided by `helm-source-in-file'."
(declare (indent 2))
`(helm-make-source ,name 'helm-source-in-file
:candidates-file ,file ,@args))
diff --git a/helm-sys.el b/helm-sys.el
index 7fd15c2ad7..85a3888ebe 100644
--- a/helm-sys.el
+++ b/helm-sys.el
@@ -39,23 +39,23 @@
(darwin "env COLUMNS=%s ps -axo
pid,user,pri,nice,ucomm,tty,start_time,vsz,%%cpu,%%mem,etime,command")
(t "env COLUMNS=%s top -b -n 1"))
"Top command used to display output of top.
-A format string where %s will be replaced with `frame-width\\='.
+A format string where %s will be replaced with `frame-width'.
-To use \\='top\\=' command, a version supporting batch mode (-b option)
-is needed. On Mac OSX \\='top\\=' command doesn\\='t support this, so the
-\\='ps\\=' command is used instead by default.
+To use 'top' command, a version supporting batch mode (-b option)
+is needed. On Mac OSX 'top' command doesn't support this, so the
+'ps' command is used instead by default.
-Normally \\='top\\=' command output have 12 columns, but in some
+Normally 'top' command output have 12 columns, but in some
versions you may have less than this, so you can either customize
-top to use 12 columns with the interactives \\='f\\=' and \\='W\\=' commands
-of top, or modify `helm-top-sort-columns-alist\\=' to fit with the
-number of columns your \\='top\\=' command is using.
+top to use 12 columns with the interactives 'f' and 'W' commands
+of top, or modify `helm-top-sort-columns-alist' to fit with the
+number of columns your 'top' command is using.
-If you modify \\='ps\\=' command be sure that \\='pid\\=' comes in first and
+If you modify 'ps' command be sure that 'pid' comes in first and
\"env COLUMNS=%s\" is specified at beginning of command. Ensure
also that no elements contain spaces (e.g., use start_time and
-not start). Same as for \\='top\\=': you can customize
-`helm-top-sort-columns-alist\\=' to make sort commands working
+not start). Same as for 'top': you can customize
+`helm-top-sort-columns-alist' to make sort commands working
properly according to your settings."
:group 'helm-sys
:type 'string)
@@ -73,21 +73,21 @@ nth 0 column."
:type '(alist :key-type symbol :value-type (integer :tag "Column number")))
(defcustom helm-top-poll-delay 1.5
- "Helm top poll after this delay when `helm-top-poll-mode\\=' is enabled.
+ "Helm top poll after this delay when `helm-top-poll-mode' is enabled.
The minimal delay allowed is 1.5, if less than this helm-top will use 1.5."
:group 'helm-sys
:type 'float)
(defcustom helm-top-poll-delay-post-command 1.0
"Helm top stop polling during this delay.
-This delay is added to `helm-top-poll-delay\\=' after Emacs stops
+This delay is added to `helm-top-poll-delay' after Emacs stops
being idle."
:group 'helm-sys
:type 'float)
(defcustom helm-top-poll-preselection 'linum
- "Stay on same line or follow candidate when `helm-top-poll\\=' updates
display.
-Possible values are \\='candidate or \\='linum.
+ "Stay on same line or follow candidate when `helm-top-poll' updates display.
+Possible values are 'candidate or 'linum.
This affects also sorting functions in the same way."
:group'helm-sys
:type '(radio :tag "Preferred preselection action for helm-top"
@@ -196,7 +196,7 @@ This affects also sorting functions in the same way."
(defvar helm-top--line nil)
(defun helm-top-transformer (candidates _source)
- "Transformer for `helm-top\\='.
+ "Transformer for `helm-top'.
Return empty string for non--valid candidates."
(cl-loop for disp in candidates collect
(cond ((string-match "^ *[0-9]+" disp) disp)
@@ -217,7 +217,7 @@ Return empty string for non--valid candidates."
(helm-next-line)))))
(defun helm-top-action-transformer (actions _candidate)
- "Action transformer for `top\\='.
+ "Action transformer for `top'.
Show actions only on line starting by a PID."
(let ((disp (helm-get-selection nil t)))
(cond ((string-match "\\` *[0-9]+" disp)
@@ -247,7 +247,7 @@ Show actions only on line starting by a PID."
(helm-remove-if-not-match "\\`[0-9]+\\'" (helm-marked-candidates)))
(defun helm-top-sh (sig pids)
- "Run kill shell command with signal SIG on PIDS for `helm-top\\='."
+ "Run kill shell command with signal SIG on PIDS for `helm-top'."
(message "kill -%s %s exited with status %s"
sig (mapconcat 'identity pids " ")
(apply #'call-process
@@ -428,7 +428,7 @@ Show actions only on line starting by a PID."
;;;###autoload
(defun helm-top ()
- "Preconfigured `helm\\=' for top command."
+ "Preconfigured `helm' for top command."
(interactive)
(add-hook 'helm-after-update-hook 'helm-top--skip-top-line)
(unwind-protect
@@ -441,7 +441,7 @@ Show actions only on line starting by a PID."
;;;###autoload
(defun helm-list-emacs-process ()
- "Preconfigured `helm\\=' for Emacs process."
+ "Preconfigured `helm' for Emacs process."
(interactive)
(helm-other-buffer 'helm-source-emacs-process "*helm process*"))
diff --git a/helm-tags.el b/helm-tags.el
index 4bc31c9d78..f977aae54d 100644
--- a/helm-tags.el
+++ b/helm-tags.el
@@ -38,12 +38,12 @@
(defcustom helm-etags-tag-file-search-limit 10
"The limit level of directory to search tag file.
-Don\\='t search tag file deeply if outside this value."
+Don't search tag file deeply if outside this value."
:type 'number
:group 'helm-tags)
(defcustom helm-etags-match-part-only 'tag
- "Allow choosing the tag part of CANDIDATE in `helm-source-etags-select\\='.
+ "Allow choosing the tag part of CANDIDATE in `helm-source-etags-select'.
A tag looks like this:
filename: (defun foo
You can choose matching against the tag part (i.e \"(defun foo\"),
@@ -54,7 +54,7 @@ or against the whole candidate (i.e \"(filename:5:(defun
foo\")."
:group 'helm-tags)
(defcustom helm-etags-execute-action-at-once-if-one t
- "Whether to jump straight to the selected tag if there\\='s only
+ "Whether to jump straight to the selected tag if there's only
one match."
:type 'boolean
:group 'helm-tags)
@@ -78,7 +78,7 @@ one match."
;;
;;
(defun helm-etags-run-switch-other-window ()
- "Run switch to other window action from `helm-source-etags-select\\='."
+ "Run switch to other window action from `helm-source-etags-select'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action
@@ -87,7 +87,7 @@ one match."
(put 'helm-etags-run-switch-other-window 'helm-only t)
(defun helm-etags-run-switch-other-frame ()
- "Run switch to other frame action from `helm-source-etags-select\\='."
+ "Run switch to other frame action from `helm-source-etags-select'."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action
@@ -113,7 +113,7 @@ one match."
(defun helm-etags-get-tag-file (&optional directory)
"Return the path of etags file if found in DIRECTORY.
Look recursively in parents directorys for a
-`helm-etags-tag-file-name\\=' file."
+`helm-etags-tag-file-name' file."
;; Get tag file from `default-directory' or upper directory.
(let ((current-dir (helm-etags-find-tag-file-directory
(or directory default-directory))))
@@ -125,9 +125,9 @@ Look recursively in parents directorys for a
"Find Etags files.
Return files from the following sources:
1) An automatically located file in the parent directories,
- by `helm-etags-get-tag-file\\='.
- 2) `tags-file-name\\=', which is commonly set by `find-tag\\=' command.
- 3) `tags-table-list\\=' which is commonly set by `visit-tags-table\\='
command."
+ by `helm-etags-get-tag-file'.
+ 2) `tags-file-name', which is commonly set by `find-tag' command.
+ 3) `tags-table-list' which is commonly set by `visit-tags-table' command."
(helm-fast-remove-dups
(delq nil
(append (list (helm-etags-get-tag-file)
@@ -163,7 +163,7 @@ If not found in CURRENT-DIR search in upper directory."
(helm-etags-get-tag-file))))
(defun helm-etags-create-buffer (file)
- "Create the `helm-buffer\\=' based on contents of etags tag FILE."
+ "Create the `helm-buffer' based on contents of etags tag FILE."
(let* (max
(split (with-temp-buffer
(insert-file-contents file)
@@ -191,7 +191,7 @@ If not found in CURRENT-DIR search in upper directory."
(progress-reporter-update progress-reporter count)))))
(defun helm-etags-init ()
- "Feed `helm-buffer\\=' using `helm-etags-cache\\=' or tag file.
+ "Feed `helm-buffer' using `helm-etags-cache' or tag file.
If there is no entry in cache, create one."
(let ((tagfiles (helm-etags-all-tag-files)))
(when tagfiles
@@ -247,7 +247,7 @@ If there is no entry in cache, create one."
(helm-highlight-current-line))))
(defcustom helm-etags-fuzzy-match nil
- "Use fuzzy matching in `helm-etags-select\\='."
+ "Use fuzzy matching in `helm-etags-select'."
:group 'helm-tags
:type 'boolean
:set (lambda (var val)
@@ -305,9 +305,9 @@ or if any of the tag files have been modified, reinitialize
cache.
This function aggregates three sources of tag files:
1) An automatically located file in the parent directories,
- by `helm-etags-get-tag-file\\='.
- 2) `tags-file-name\\=', which is commonly set by `find-tag\\=' command.
- 3) `tags-table-list\\=' which is commonly set by `visit-tags-table\\='
command."
+ by `helm-etags-get-tag-file'.
+ 2) `tags-file-name', which is commonly set by `find-tag' command.
+ 3) `tags-table-list' which is commonly set by `visit-tags-table' command."
(interactive "P")
(let ((tag-files (helm-etags-all-tag-files))
(helm-execute-action-at-once-if-one
diff --git a/helm-utils.el b/helm-utils.el
index 6bb866b80b..2d91de31e7 100644
--- a/helm-utils.el
+++ b/helm-utils.el
@@ -105,11 +105,11 @@ Where PA means persistent action."
(defcustom helm-html-decode-entities-function
#'helm-html-decode-entities-string
"Function used to decode HTML entities in HTML bookmarks.
-Helm comes by default with `helm-html-decode-entities-string\\=', if
+Helm comes by default with `helm-html-decode-entities-string', if
you need something more sophisticated you can use
-`w3m-decode-entities-string\\=' if available.
+`w3m-decode-entities-string' if available.
-In Emacs itself org-entities seem broken and
`xml-substitute-numeric-entities\\='
+In Emacs itself org-entities seem broken and `xml-substitute-numeric-entities'
supports only numeric entities."
:group 'helm-utils
:type 'function)
@@ -117,17 +117,17 @@ supports only numeric entities."
(defvar helm-goto-line-before-hook '(helm-save-current-pos-to-mark-ring)
"Run before jumping to line.
-This hook runs when jumping from `helm-goto-line\\=',
`helm-etags-default-action\\=',
-and `helm-imenu-default-action\\='.
+This hook runs when jumping from `helm-goto-line', `helm-etags-default-action',
+and `helm-imenu-default-action'.
This allows you to retrieve a previous position after using the different helm
tools for searching (etags, grep, gid, (m)occur etc...).
-By default positions are added to `mark-ring\\='.
+By default positions are added to `mark-ring'.
You can also add to register by using (or adding)
-`helm-save-pos-to-register-before-jump\\=' instead. In this case
-last position is added to the register
`helm-save-pos-before-jump-register\\='.")
+`helm-save-pos-to-register-before-jump' instead. In this case
+last position is added to the register `helm-save-pos-before-jump-register'.")
(defvar helm-save-pos-before-jump-register ?_
- "The register where `helm-save-pos-to-register-before-jump\\=' saves
position.")
+ "The register where `helm-save-pos-to-register-before-jump' saves position.")
(defconst helm-html-entities-alist
'((""" . 34) ;; "
@@ -237,14 +237,14 @@ last position is added to the register
`helm-save-pos-before-jump-register\\='."
See https://www.freeformatter.com/html-entities.html";)
(defvar helm-find-many-files-after-hook nil
- "Hook that runs at end of `helm-find-many-files\\='.")
+ "Hook that runs at end of `helm-find-many-files'.")
;;; Faces.
;;
(defface helm-selection-line
`((t ,@(and (>= emacs-major-version 27) '(:extend t))
:inherit highlight :distant-foreground "black"))
- "Face used in the `helm-current-buffer\\=' when jumping to a candidate."
+ "Face used in the `helm-current-buffer' when jumping to a candidate."
:group 'helm-faces)
(defface helm-match-item
@@ -260,15 +260,15 @@ See https://www.freeformatter.com/html-entities.html";)
(defcustom helm-window-prefer-horizontal-split nil
"Maybe switch to other window vertically when non nil.
-Possible values are t, nil and `decide\\='.
+Possible values are t, nil and `decide'.
When t switch vertically.
When nil switch horizontally.
-When `decide\\=' try to guess if it is possible to switch vertically
-according to the setting of `split-width-threshold\\=' and the size of
+When `decide' try to guess if it is possible to switch vertically
+according to the setting of `split-width-threshold' and the size of
the window from where splitting is done.
-Note that when using `decide\\=' and `split-width-threshold\\=' is nil, the
+Note that when using `decide' and `split-width-threshold' is nil, the
behavior is the same as with a nil value."
:group 'helm-utils
:type '(choice
@@ -343,9 +343,9 @@ If a prefix arg is given split windows vertically."
(defun helm-window-default-split-fn (candidates &optional other-window-fn)
"Split windows in one direction and balance them.
-Direction can be controlled via `helm-window-prefer-horizontal-split\\='.
+Direction can be controlled via `helm-window-prefer-horizontal-split'.
If a prefix arg is given split windows the other direction.
-This function is suitable for `helm-window-show-buffers-function\\='."
+This function is suitable for `helm-window-show-buffers-function'."
(if other-window-fn
(funcall other-window-fn (car candidates))
(switch-to-buffer (car candidates)))
@@ -361,9 +361,9 @@ This function is suitable for
`helm-window-show-buffers-function\\='."
(defun helm-window-alternate-split-fn (candidates &optional other-window-fn)
"Split windows horizontally and vertically in alternate fashion.
-Direction can be controlled via `helm-window-prefer-horizontal-split\\='.
+Direction can be controlled via `helm-window-prefer-horizontal-split'.
If a prefix arg is given split windows the other direction.
-This function is suitable for `helm-window-show-buffers-function\\='."
+This function is suitable for `helm-window-show-buffers-function'."
(if other-window-fn
(funcall other-window-fn (car candidates))
(switch-to-buffer (car candidates)))
@@ -383,10 +383,10 @@ This function is suitable for
`helm-window-show-buffers-function\\='."
"Make an as-square-as-possible window mosaic of the CANDIDATES buffers.
If rectangular, the long side is in the direction given by
-`helm-window-prefer-horizontal-split\\=': if non-nil, it is horizontal,
vertical
+`helm-window-prefer-horizontal-split': if non-nil, it is horizontal, vertical
otherwise.
If OTHER-WINDOW-FN is non-nil, current windows are included in the mosaic.
-This function is suitable for `helm-window-show-buffers-function\\='."
+This function is suitable for `helm-window-show-buffers-function'."
(when other-window-fn
(setq candidates (append (mapcar 'window-buffer (window-list))
candidates)))
(delete-other-windows)
@@ -451,9 +451,9 @@ This function is suitable for
`helm-window-show-buffers-function\\='."
(defun helm-window-other-window (buffer-or-name &optional balance)
"Switch to BUFFER-OR-NAME in other window.
-Direction can be controlled via `helm-window-prefer-horizontal-split\\='.
+Direction can be controlled via `helm-window-prefer-horizontal-split'.
If a prefix arg is given split windows the other direction.
-When argument BALANCE is provided `balance-windows\\='."
+When argument BALANCE is provided `balance-windows'."
(let* ((helm-window-prefer-horizontal-split
(if (eq helm-window-prefer-horizontal-split 'decide)
(and (numberp split-width-threshold)
@@ -470,7 +470,7 @@ When argument BALANCE is provided `balance-windows\\='."
(cl-defun helm-current-buffer-narrowed-p (&optional
(buffer helm-current-buffer))
"Check if BUFFER is narrowed.
-Default is `helm-current-buffer\\='."
+Default is `helm-current-buffer'."
(with-current-buffer buffer
(let ((beg (point-min))
(end (point-max))
@@ -514,15 +514,15 @@ Animation is used unless NOANIM is non--nil."
(helm-highlight-current-line)))
(defun helm-save-pos-to-register-before-jump ()
- "Save current buffer position to `helm-save-pos-before-jump-register\\='.
-To use this add it to `helm-goto-line-before-hook\\='."
+ "Save current buffer position to `helm-save-pos-before-jump-register'.
+To use this add it to `helm-goto-line-before-hook'."
(with-helm-current-buffer
(unless helm-in-persistent-action
(point-to-register helm-save-pos-before-jump-register))))
(defun helm-save-current-pos-to-mark-ring ()
"Save current buffer position to mark ring.
-To use this add it to `helm-goto-line-before-hook\\='."
+To use this add it to `helm-goto-line-before-hook'."
(with-helm-current-buffer
(unless helm-in-persistent-action
(set-marker (mark-marker) (point))
@@ -548,7 +548,7 @@ candidate-number-limit."
(put 'helm-show-all-candidates-in-source 'helm-only t)
(defun helm-display-all-sources ()
- "Display all sources previously hidden by `helm-set-source-filter\\='."
+ "Display all sources previously hidden by `helm-set-source-filter'."
(interactive)
(with-helm-alive-p
(helm-set-source-filter nil)))
@@ -565,16 +565,16 @@ candidate-number-limit."
do (forward-line 1))))
(defun helm-handle-winner-boring-buffers ()
- "Add `helm-buffer\\=' to `winner-boring-buffers\\=' when quitting/exiting
helm.
-Add this function to `helm-cleanup-hook\\=' when you don\\='t want to see helm
buffers
+ "Add `helm-buffer' to `winner-boring-buffers' when quitting/exiting helm.
+Add this function to `helm-cleanup-hook' when you don't want to see helm
buffers
after running winner-undo/redo."
(require 'winner)
(cl-pushnew helm-buffer winner-boring-buffers :test 'equal))
(add-hook 'helm-cleanup-hook #'helm-handle-winner-boring-buffers)
(defun helm-quit-and-find-file ()
- "Drop into `helm-find-files\\=' from `helm\\='.
-If current selection is a buffer or a file, `helm-find-files\\='
+ "Drop into `helm-find-files' from `helm'.
+If current selection is a buffer or a file, `helm-find-files'
from its directory."
(interactive)
(with-helm-alive-p
@@ -628,7 +628,7 @@ from its directory."
(defun helm-generic-sort-fn (s1 s2)
"Sort predicate function for helm candidates.
-Args S1 and S2 can be single or (display . real) candidates,
+Args S1 and S2 can be single or \(display . real\) candidates,
that is sorting is done against real value of candidate."
(let* ((qpattern (regexp-quote helm-pattern))
(reg1 (concat "\\_<" qpattern "\\_>"))
@@ -669,9 +669,9 @@ that is sorting is done against real value of candidate."
(cl-defun helm-file-human-size (size &optional (kbsize helm-default-kbsize))
"Return a string showing SIZE of a file in human readable form.
-SIZE can be an integer or a float depending on it\\='s value.
-`file-attributes\\=' will take care of that to avoid overflow error.
-KBSIZE is a floating point number, defaulting to `helm-default-kbsize\\='."
+SIZE can be an integer or a float depending on it's value.
+`file-attributes' will take care of that to avoid overflow error.
+KBSIZE is a floating point number, defaulting to `helm-default-kbsize'."
(cl-loop with result = (cons "B" size)
for i in '("k" "M" "G" "T" "P" "E" "Z" "Y")
while (>= (cdr result) kbsize)
@@ -686,7 +686,7 @@ KBSIZE is a floating point number, defaulting to
`helm-default-kbsize\\='."
If RECURSIVE is non nil return the size of all files in DIRECTORY and
its subdirectories. With arg HUMAN format the size in a human
-readable format,see `helm-file-human-size\\='."
+readable format,see `helm-file-human-size'."
(cl-loop with files = (if recursive
(helm-walk-directory
directory
@@ -703,32 +703,32 @@ readable format,see `helm-file-human-size\\='."
(file &key type links uid gid access-time modif-time
status size mode gid-change inode device-num dired human-size
mode-type mode-owner mode-group mode-other (string t))
- "Return `file-attributes\\=' elements of FILE separately according to key
value.
+ "Return `file-attributes' elements of FILE separately according to key value.
Availables keys are:
-- TYPE: Same as nth 0 `files-attributes\\=' if STRING is nil
+- TYPE: Same as nth 0 `files-attributes' if STRING is nil
otherwise return either symlink, directory or file (default).
-- LINKS: See nth 1 `files-attributes\\='.
-- UID: See nth 2 `files-attributes\\='.
-- GID: See nth 3 `files-attributes\\='.
-- ACCESS-TIME: See nth 4 `files-attributes\\=', however format time
+- LINKS: See nth 1 `files-attributes'.
+- UID: See nth 2 `files-attributes'.
+- GID: See nth 3 `files-attributes'.
+- ACCESS-TIME: See nth 4 `files-attributes', however format time
when STRING is non--nil (the default).
-- MODIF-TIME: See nth 5 `files-attributes\\=', same as above.
-- STATUS: See nth 6 `files-attributes\\=', same as above.
-- SIZE: See nth 7 `files-attributes\\='.
-- MODE: See nth 8 `files-attributes\\='.
-- GID-CHANGE: See nth 9 `files-attributes\\='.
-- INODE: See nth 10 `files-attributes\\='.
-- DEVICE-NUM: See nth 11 `files-attributes\\='.
-- DIRED: A line similar to what \\='ls -l\\=' return.
-- HUMAN-SIZE: The size in human form, see `helm-file-human-size\\='.
+- MODIF-TIME: See nth 5 `files-attributes', same as above.
+- STATUS: See nth 6 `files-attributes', same as above.
+- SIZE: See nth 7 `files-attributes'.
+- MODE: See nth 8 `files-attributes'.
+- GID-CHANGE: See nth 9 `files-attributes'.
+- INODE: See nth 10 `files-attributes'.
+- DEVICE-NUM: See nth 11 `files-attributes'.
+- DIRED: A line similar to what 'ls -l' return.
+- HUMAN-SIZE: The size in human form, see `helm-file-human-size'.
- MODE-TYPE, mode-owner,mode-group, mode-other: Split what
- nth 7 `files-attributes\\=' return in four categories.
-- STRING: When non--nil (default) `helm-file-attributes\\=' return
+ nth 7 `files-attributes' return in four categories.
+- STRING: When non--nil (default) `helm-file-attributes' return
more friendly values.
-If you want the same behavior as `files-attributes\\=' ,
-\(but with return values in proplist) use a nil value for STRING.
+If you want the same behavior as `files-attributes' ,
+\(but with return values in proplist\) use a nil value for STRING.
However when STRING is non--nil, time and type value are different from what
-you have in `file-attributes\\='."
+you have in `file-attributes'."
(helm-aif (file-attributes file string)
(let* ((all (cl-destructuring-bind
(type links uid gid access-time modif-time
@@ -808,7 +808,7 @@ If STRING is non--nil return instead a space separated
string."
(list :mode-type type :user user :group group :other other))))
(defun helm-format-columns-of-files (files)
- "Same as `dired-format-columns-of-files\\='.
+ "Same as `dired-format-columns-of-files'.
Inlined here for compatibility."
(let ((beg (point)))
(completion--insert-strings files)
@@ -1034,7 +1034,7 @@ Assume regexp is a pcre based regexp."
file))))
(defun helm-open-dired (file)
- "Open a dired buffer in FILE\\='s directory.
+ "Open a dired buffer in FILE's directory.
If FILE is a directory, open this directory."
(require 'dired)
(if (file-directory-p file)
@@ -1060,8 +1060,8 @@ If FILE is a directory, open this directory."
(find-file remote-path))))
(defun helm-find-many-files (_ignore)
- "Simple action that run `find-file\\=' on marked candidates.
-Run `helm-find-many-files-after-hook\\=' at end."
+ "Simple action that run `find-file' on marked candidates.
+Run `helm-find-many-files-after-hook' at end."
(let ((helm--reading-passwd-or-string t))
(mapc 'find-file (helm-marked-candidates))
(helm-log-run-hook 'helm-find-many-files-after-hook)))
diff --git a/helm-x-files.el b/helm-x-files.el
index 37895e5add..17c35e7b8a 100644
--- a/helm-x-files.el
+++ b/helm-x-files.el
@@ -28,7 +28,7 @@
(defvar dired-buffers)
(defvar directory-files-no-dot-files-regexp)
(defun helm-files-in-all-dired-candidates ()
- "Return a list of files from live `dired\\=' buffers."
+ "Return a list of files from live `dired' buffers."
(save-excursion
(cl-loop for (f . b) in dired-buffers
when (buffer-live-p b)
@@ -64,7 +64,7 @@
"File list from emacs-session.")
(defcustom helm-session-fuzzy-match nil
- "Enable fuzzy matching in `helm-source-session\\=' when non--nil."
+ "Enable fuzzy matching in `helm-source-session' when non--nil."
:group 'helm-files
:type 'boolean
:set (lambda (var val)
@@ -119,7 +119,7 @@
(defvar helm-source-mac-spotlight
(helm-make-source "mdfind" 'helm-mac-spotlight-source)
- "Source for retrieving files via Spotlight\\='s command line utility
mdfind.")
+ "Source for retrieving files via Spotlight's command line utility mdfind.")
(provide 'helm-x-files)