branch: elpa/helm
commit 1003539c2ec66e7697903f4b4cb354adea70040e
Author: Thierry Volpiatto <thie...@posteo.net>
Commit: Thierry Volpiatto <thie...@posteo.net>
Fix some warnings
---
helm-adaptive.el | 3 ++-
helm-buffers.el | 2 +-
helm-core.el | 9 +++++----
helm-fd.el | 2 ++
helm-files.el | 16 +++++++---------
helm-grep.el | 3 ++-
helm-imenu.el | 2 +-
helm-lib.el | 11 +++++++----
helm-mode.el | 16 ++++++++++------
helm-occur.el | 3 ++-
helm-ring.el | 3 ++-
helm-tags.el | 6 ++++--
helm-utils.el | 10 ++++++----
helm-x-files.el | 3 +--
14 files changed, 52 insertions(+), 37 deletions(-)
diff --git a/helm-adaptive.el b/helm-adaptive.el
index a44b514869..40df940579 100644
--- a/helm-adaptive.el
+++ b/helm-adaptive.el
@@ -65,7 +65,8 @@ selection.")
(defvar helm-adaptive-history nil
"Contains the stored history information.
-Format: ((SOURCE-NAME (SELECTED-CANDIDATE (PATTERN . NUMBER-OF-USE) ...) ...)
...)")
+Format: ((SOURCE-NAME
+ (SELECTED-CANDIDATE (PATTERN . NUMBER-OF-USE) ...) ...) ...)")
(defconst helm-adaptive-freq-coefficient 5)
(defconst helm-adaptive-recent-coefficient 2)
diff --git a/helm-buffers.el b/helm-buffers.el
index 31bda4b461..ccdd778e4d 100644
--- a/helm-buffers.el
+++ b/helm-buffers.el
@@ -292,7 +292,7 @@ Note that this variable is buffer-local.")
;; directly so that each list of candidates is local to source.
(helm-set-attr 'candidates (funcall (helm-get-attr 'buffer-list)))
(let ((result (cl-loop with allbufs = (memq 'helm-shadow-boring-buffers
- (helm-attr
+ (helm-get-attr
'filtered-candidate-transformer
helm-source-buffers-list))
for b in (if allbufs
diff --git a/helm-core.el b/helm-core.el
index 4d49bf989f..4402b7a9a6 100644
--- a/helm-core.el
+++ b/helm-core.el
@@ -95,7 +95,8 @@ See `helm-define-multi-key'."
(defun helm-make-multi-command (functions &optional delay)
"Return an anonymous multi-key command running FUNCTIONS.
-Run each function in the FUNCTIONS list in turn when called within DELAY
seconds."
+Run each function in the FUNCTIONS list in turn when called within
+DELAY seconds."
(declare (indent 1))
(let ((funs functions)
(iter (cl-gensym "helm-iter-key"))
@@ -1758,7 +1759,7 @@ It also accepts function or variable symbol.")
(defvar helm-autoresize-mode) ;; Undefined in `helm-default-display-buffer'.
(defvar helm-async-outer-limit-hook nil
- "A hook that runs in async sources when process output comes out of
`candidate-number-limit'.
+ "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
@@ -4452,11 +4453,11 @@ the candidates."
((> scr1 scr2)))))))))
(defun helm-fuzzy-matching-default-sort-fn (candidates _source)
- "Default `filtered-candidate-transformer' to sort candidates 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)
- "`filtered-candidate-transformer' to sort candidates in fuzzy matching,
preserving order of ties.
+ "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
diff --git a/helm-fd.el b/helm-fd.el
index 7e5c46dffb..1ee105e04a 100644
--- a/helm-fd.el
+++ b/helm-fd.el
@@ -20,6 +20,8 @@
(require 'helm)
(require 'helm-types)
+(declare-function ansi-color-apply "ansi-color.el")
+
(defvar helm-fd-executable "fd"
"The fd shell command executable.")
diff --git a/helm-files.el b/helm-files.el
index 31b8e6cebf..848e49ef04 100644
--- a/helm-files.el
+++ b/helm-files.el
@@ -31,17 +31,14 @@
(require 'thingatpt)
(require 'ffap)
(require 'dired-aux)
- (require 'dired-x)
- (require 'image-dired))
+ (require 'dired-x))
(require 'filenotify)
(require 'image-mode)
+(require 'image-dired)
(declare-function find-library-name "find-func.el" (library))
(declare-function w32-shell-execute "ext:w32fns.c" (operation document
&optional parameters show-flag))
(declare-function gnus-dired-attach "ext:gnus-dired.el" (files-to-attach))
-(declare-function image-dired-display-image "image-dired.el" (file &optional
original-size))
-(declare-function image-dired-update-property "image-dired.el" (prop value))
-(declare-function image-dired-get-thumbnail-image "image-dired.el")
(declare-function eshell-read-aliases-list "em-alias")
(declare-function eshell-send-input "esh-mode" (&optional use-region queue-p
no-newline))
(declare-function eshell-kill-input "esh-mode")
@@ -90,6 +87,7 @@
(declare-function all-the-icons-icon-for-file "ext:all-the-icons.el")
(declare-function all-the-icons-octicon "ext:all-the-icons.el")
(declare-function all-the-icons-match-to-alist "ext:all-the-icons.el")
+(declare-function helm-adaptive-sort "ext:helm-adaptive.el")
(defvar all-the-icons-dir-icon-alist)
(defvar term-char-mode-point-at-process-mark)
@@ -867,6 +865,8 @@ than `helm-candidate-number-limit'.")
(defvar helm-ff--trashed-files nil
"[INTERNAL] Files already trashed are stored here during file deletion.
This is used only as a let binding.")
+(defvar helm-ff--show-thumbnails nil)
+(defvar helm-ff--thumbnailed-directories nil)
;;; Helm-find-files
;;
@@ -4899,8 +4899,6 @@ Special commands:
;;; Thumbnails view
;;
-(defvar helm-ff--show-thumbnails nil)
-(defvar helm-ff--thumbnailed-directories nil)
(defun helm-ff-maybe-show-thumbnails (candidates _source)
(require 'image-dired)
(if (and helm-ff--show-thumbnails
@@ -4967,8 +4965,8 @@ Special commands:
;;;###autoload
(defun helm-ff-cleanup-image-dired-dir-and-cache ()
"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'."
+Delete all thumb files that are no more associated with an existing
+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)
diff --git a/helm-grep.el b/helm-grep.el
index d212afe929..66c7e70334 100644
--- a/helm-grep.el
+++ b/helm-grep.el
@@ -89,7 +89,8 @@ 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\"
\"ms=30;43:mc=30;43:sl=01;37:cx=:fn=35:ln=32:bn=32:se=36\")
+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\".
To customize the ANSI color in git-grep, GREP_COLORS have no effect,
diff --git a/helm-imenu.el b/helm-imenu.el
index 862a158533..0844d6e28e 100644
--- a/helm-imenu.el
+++ b/helm-imenu.el
@@ -344,7 +344,7 @@ string."
;;;###autoload
(defun helm-imenu-in-all-buffers ()
- "Preconfigured `helm' for fetching imenu entries in all buffers with similar
mode as current.
+ "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'."
diff --git a/helm-lib.el b/helm-lib.el
index 6324042a03..a1b12408ca 100644
--- a/helm-lib.el
+++ b/helm-lib.el
@@ -1111,10 +1111,12 @@ function with SUBEXP specified.
E.g.:
- (helm--replace-regexp-in-buffer-string \"e\\\\(m\\\\)acs\" 'upcase
\"emacs\" t nil 1)
+ (helm--replace-regexp-in-buffer-string
+ \"e\\\\(m\\\\)acs\" 'upcase \"emacs\" t nil 1)
=> \"eMacs\"
- (replace-regexp-in-string \"e\\\\(m\\\\)acs\" 'upcase \"emacs\" t nil 1)
+ (replace-regexp-in-string
+ \"e\\\\(m\\\\)acs\" 'upcase \"emacs\" t nil 1)
=> \"eEMACSacs\"
Also START argument behaves as expected unlike
@@ -1290,7 +1292,8 @@ FUNC can be a symbol or a string.
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'."
+TYPE when nil specify function, for other values see
+`find-function-regexp-alist'."
(require 'find-func)
(let* ((sym (helm-symbolify func))
(dir (or root-dir (helm-read-file-name
@@ -1697,7 +1700,7 @@ flex or helm-flex completion style if present."
1 0))))))
(defun helm-dynamic-completion (collection predicate &optional point metadata
nomode styles)
- "Build a function listing the possible completions of `helm-pattern' in
COLLECTION.
+ "Build a completion function for `helm-pattern' in COLLECTION.
Only the elements of COLLECTION that satisfy PREDICATE are considered.
diff --git a/helm-mode.el b/helm-mode.el
index 76a8ae275e..1ac8e6a4c7 100644
--- a/helm-mode.el
+++ b/helm-mode.el
@@ -295,8 +295,8 @@ There are three possible values to use:
`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.
+ 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
@@ -692,7 +692,7 @@ Keys description:
- 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.
+- MARKED-CANDIDATES: If non-nil return candidate or marked candidates as a
list.
- NOMARK: When non--nil don't allow marking candidates.
@@ -1295,6 +1295,7 @@ See documentation of `completing-read' and
`all-completions' for details."
(persistent-help "Hit1 Expand Candidate, Hit2 or (C-u) Find file")
(mode-line helm-read-file-name-mode-line-string))
"Read a file name with helm completion.
+
It is helm `read-file-name' emulation.
Argument PROMPT is the default prompt to use.
@@ -1303,7 +1304,8 @@ Keys description:
- NAME: Source name, default to \"Read File Name\".
-- INITIAL-INPUT: Where to start reading file name, default to
`default-directory' or $HOME.
+- INITIAL-INPUT: Where to start reading file name,
+ default to `default-directory' or $HOME.
- BUFFER: `helm-buffer' name, defaults to \"*Helm Completions*\".
@@ -1326,13 +1328,15 @@ Keys description:
- NOMARK: When non--nil don't allow marking candidates.
-- ALISTP: Don't use `all-completions' in history (take effect only on history).
+- ALISTP: Don't use `all-completions' in history
+ (take effect only on history).
- PERSISTENT-ACTION-IF: a persistent if action function.
- PERSISTENT-HELP: persistent help message.
-- MODE-LINE: A mode line message, default is
`helm-read-file-name-mode-line-string'."
+- MODE-LINE: A mode line message, default is
+ `helm-read-file-name-mode-line-string'."
(require 'tramp)
(unless initial-input
(setq initial-input (or default-directory (getenv "HOME"))))
diff --git a/helm-occur.el b/helm-occur.el
index 4e67204dd7..f9691b1b7d 100644
--- a/helm-occur.el
+++ b/helm-occur.el
@@ -126,7 +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)
diff --git a/helm-ring.el b/helm-ring.el
index 4ae4faa2df..472ccf65c3 100644
--- a/helm-ring.el
+++ b/helm-ring.el
@@ -495,7 +495,8 @@ This is a command for `helm-kill-ring-map'."
;;;###autoload
(defun helm-all-mark-rings ()
- "Preconfigured `helm' for `helm-source-global-mark-ring' and \
+ "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
diff --git a/helm-tags.el b/helm-tags.el
index 7903a2f800..d2b3ea9408 100644
--- a/helm-tags.el
+++ b/helm-tags.el
@@ -122,8 +122,10 @@ Look recursively in parents directorys for a
(expand-file-name helm-etags-tag-file-name current-dir))))
(defun helm-etags-all-tag-files ()
- "Return files from the following sources:
- 1) An automatically located file in the parent directories, by
`helm-etags-get-tag-file'.
+ "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."
(helm-fast-remove-dups
diff --git a/helm-utils.el b/helm-utils.el
index a73180c2cc..4fe76d063c 100644
--- a/helm-utils.el
+++ b/helm-utils.el
@@ -45,7 +45,7 @@
(defvar helm-buffers-maybe-switch-to-tab)
(defvar helm-ff-transformer-show-only-basename)
(defvar helm-popup-tip-mode)
-
+(defvar helm-ff-last-expanded-candidate-regexp)
(defgroup helm-utils nil
@@ -88,7 +88,8 @@ Possible value are:
(const :tag "Never match" 'never)))
(defcustom helm-buffers-to-resize-on-pa nil
- "A list of helm buffers where the helm-window should be reduced on
persistent actions."
+ "A list of helm buffers where the helm-window should be reduced on PA.
+Where PA means persistent action."
:group 'helm-utils
:type '(repeat (choice string)))
@@ -104,8 +105,9 @@ Possible value are:
(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 you need
something
-more sophisticated you can use `w3m-decode-entities-string' if available.
+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.
In Emacs itself org-entities seem broken and `xml-substitute-numeric-entities'
supports only numeric entities."
diff --git a/helm-x-files.el b/helm-x-files.el
index 27f2e47442..2efd5fd9ce 100644
--- a/helm-x-files.el
+++ b/helm-x-files.el
@@ -107,8 +107,7 @@
:action-transformer '(helm-transform-file-load-el
helm-transform-file-browse-url)
:requires-pattern 3)
- "Source for retrieving files matching the current input pattern \
-with the tracker desktop search.")
+ "Source for the Tracker desktop search engine.")
;; Spotlight (MacOS X desktop search)
(defclass helm-mac-spotlight-source (helm-source-async helm-type-file)
