[elpa] externals/dired-duplicates c94b14724a 21/57: flymake: Fix docstrings issues

[ELPA Syncer]

branch: externals/dired-duplicates
commit c94b14724a7ade318c25f4832f0150aac2d627c4
Author: Harald Judt <h.judt@gmx.at>
Commit: Harald Judt <h.judt@gmx.at>

    flymake: Fix docstrings issues
---
 find-dupes-dired.el | 29 +++++++++++++++++------------
 1 file changed, 17 insertions(+), 12 deletions(-)

diff --git a/find-dupes-dired.el b/find-dupes-dired.el
index 1de2cff845..ec79a73caf 100644
--- a/find-dupes-dired.el
+++ b/find-dupes-dired.el
@@ -18,7 +18,7 @@
 (defcustom find-duplicates-separator-file
   (concat "/tmp/-" (make-string 40 ?-))
   "Path and name of the separator file used for making search
-results easier to discern. It will be created immediately before
+results easier to discern.  It will be created immediately before
 and deleted as soon as possible after the search operation
 finishes."
   :group 'find-duplicates
@@ -44,7 +44,7 @@ ascending or descending order."
 
 (defcustom find-duplicates-file-filter-functions
   nil
-  "Filter functions applied to all files found in a directory. A
+  "Filter functions applied to all files found in a directory.  A
 filter function must accept as its single argument the file and
 return boolean t if the file matches a criteria, otherwise nil."
   :group 'find-duplicates
@@ -55,7 +55,8 @@ return boolean t if the file matches a criteria, otherwise 
nil."
   "List of directories that will be searched for duplicate files.")
 
 (defun find-duplicates-checksum-file (file)
-  "Create a checksum for `file', using executable defined by 
`find-duplicates-checksum-exec'."
+  "Create a checksum for FILE, using executable defined by
+`find-duplicates-checksum-exec'."
   (let* ((default-directory (file-name-directory (expand-file-name file)))
          (exec (executable-find find-duplicates-checksum-exec t)))
     (unless exec
@@ -67,7 +68,8 @@ return boolean t if the file matches a criteria, otherwise 
nil."
             t))))
 
 (defun find-duplicates--ensure-separator-file ()
-  "Ensure that the separator file specified by 
`find-duplicates-separator-file' exists."
+  "Ensure that the separator file specified by
+`find-duplicates-separator-file' exists."
     (unless (file-exists-p find-duplicates-separator-file)
       (make-empty-file find-duplicates-separator-file)))
 
@@ -86,19 +88,20 @@ return boolean t if the file matches a criteria, otherwise 
nil."
        (find-duplicates--remove-separator-file))))
 
 (defun find-duplicates--apply-file-filter-functions (files)
+  "Apply file filter functions to FILES, returning the resulting list."
   (if (and find-duplicates-file-filter-functions files)
       (dolist (filter-func find-duplicates-file-filter-functions files)
         (setf files (delete-if-not filter-func files)))
     files))
 
 (defun find-duplicates--find-and-filter-files (directories)
-  "Given one or more root directories, search below the directories
-for duplicate files. Returns a hash-table with the checksums as
+  "Given one or more root DIRECTORIES, search below the directories
+for duplicate files.  Returns a hash-table with the checksums as
 keys and a list of size and duplicate files as values."
   (cl-loop with files = (find-duplicates--apply-file-filter-functions
                          (mapcan #'(lambda (d)
                                      (directory-files-recursively d ".*"))
-                                       (ensure-list directories)))
+                                 (ensure-list directories)))
            and same-size-table = (make-hash-table)
            and checksum-table = (make-hash-table :test 'equal)
            for f in files
@@ -123,8 +126,9 @@ keys and a list of size and duplicate files as values."
            (cl-return checksum-table)))
 
 (defun find-duplicates--generate-dired-list (&optional directories)
-  "Generate a list of grouped duplicate files, optionally separated
-by a separator file specified by `find-duplicates-separator-file'."
+  "Generate a list of grouped duplicate files in DIRECTORIES,
+optionally separated by a separator file specified by
+`find-duplicates-separator-file'."
   (cl-loop with dupes-table = (find-duplicates--find-and-filter-files
                                (or directories
                                    find-duplicates-directories))
@@ -138,7 +142,8 @@ by a separator file specified by 
`find-duplicates-separator-file'."
            when find-duplicates-use-separators append (list 
find-duplicates-separator-file)))
 
 (defun find-duplicates-revert-function (&optional arg noconfirm)
-  "Revert function used instead of `dired-revert' for dired buffers generated 
by find-duplicates."
+  "Revert function used instead of `dired-revert' for dired buffers
+generated by find-duplicates."
   (message "Looking for remaining duplicate files...")
   (setq-local dired-directory
               (append (list (first dired-directory))
@@ -149,8 +154,8 @@ by a separator file specified by 
`find-duplicates-separator-file'."
 
 ;;;###autoload
 (defun find-duplicates-dired (directories)
-  "Find a list of duplicate files inside one or more directories
-and show them in a dired buffer."
+  "Find a list of duplicate files inside one or more DIRECTORIES
+and show them in a `dired' buffer."
   (interactive (list (completing-read-multiple "Directories: "
                                                #'read-file-name-internal
                                                #'file-directory-p