[elpa] externals/dired-duplicates 4fde2fbfa7 33/57: Fix first lines of docstrings

[ELPA Syncer]

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

    Fix first lines of docstrings
---
 find-duplicates.el | 56 ++++++++++++++++++++++++++++++++----------------------
 1 file changed, 33 insertions(+), 23 deletions(-)

diff --git a/find-duplicates.el b/find-duplicates.el
index b1811bd636..15421b0b4d 100644
--- a/find-duplicates.el
+++ b/find-duplicates.el
@@ -60,26 +60,30 @@
 
 (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
-and deleted as soon as possible after the search operation
-finishes."
+  "Path and name of the separator file.
+
+This file is used for making search results easier to discern.
+It will be created immediately before and deleted as soon as
+possible after the search operation finishes."
   :group 'find-duplicates
   :tag "Separator dummy file"
   :type 'string)
 
 (defcustom find-duplicates-checksum-exec
   "sha256sum"
-  "Name of the executable used for creating file checksums for
-comparison."
+  "Name of the executable used for creating file checksums.
+
+The checksums will be used for comparison of files of the same
+size."
   :group 'find-duplicates
   :tag "Checksum executable"
   :type 'string)
 
 (defcustom find-duplicates-size-comparison-function
   '<
-  "The comparison function used for sorting grouped results in
-ascending or descending order."
+  "The comparison function used for sorting grouped results.
+
+The sorting can be in ascending (<) or descending (>) order."
   :group 'find-duplicates
   :tag "Ascending or descending file size sort order"
   :type '(choice (const :tag "Ascending" :value <)
@@ -87,8 +91,9 @@ ascending or descending order."
 
 (defcustom find-duplicates-file-filter-functions
   nil
-  "Filter functions applied to all files found in a directory.  A
-filter function must accept as its single argument the file and
+  "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
   :tag "File filter functions"
@@ -105,8 +110,9 @@ 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.
+
+The executable used is 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
@@ -118,8 +124,9 @@ 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 exists.
+
+The file is specified by `find-duplicates-separator-file'."
   (unless (file-exists-p find-duplicates-separator-file)
     (make-empty-file find-duplicates-separator-file)))
 
@@ -146,9 +153,11 @@ return boolean t if the file matches a criteria, otherwise 
nil."
     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
-keys and a list of size and duplicate files as values."
+  "Search below DIRECTORIES for duplicate files.
+
+It is possible to provide one or more root DIRECTORIES.  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)
@@ -179,8 +188,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 in DIRECTORIES,
-optionally separated by a separator file specified by
+  "Generate a list of grouped duplicate files in DIRECTORIES.
+
+Optionally they can be separated by a separator file specified by
 `find-duplicates-separator-file'."
   (cl-loop with dupes-table = (find-duplicates--find-and-filter-files
                                (or directories
@@ -195,8 +205,7 @@ optionally separated by a separator file specified by
            when find-duplicates-use-separators append (list 
find-duplicates-separator-file)))
 
 (defun find-duplicates-dired-revert (&optional arg noconfirm)
-  "Revert function used instead of `dired-revert' for Dired buffers
-generated by `find-duplicates-dired'.
+  "Revert function used instead of `dired-revert' for Dired buffers.
 
 The args ARG and NOCONFIRM are passed through from
 `revert-buffer' to `dired-revert'."
@@ -210,8 +219,9 @@ The args ARG and NOCONFIRM are passed through from
 
 ;;;###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.
+
+The results will be shown in a Dired buffer."
   (interactive (list (completing-read-multiple "Directories: "
                                                #'read-file-name-internal
                                                #'file-directory-p