about summary refs log tree commit diff
diff options
context:
space:
mode:
authorArun Isaac2017-02-21 23:17:52 +0530
committerArun Isaac2017-02-21 23:17:52 +0530
commit245b1bffa6c325d6276ead70303472a60f0a17c5 (patch)
tree8795979b94fd6acd65b28ad2f58a7e704c7f429e
parentdc8170f6784d3129ec31a50b00ec7d1e2671136a (diff)
downloadexiftool.el-245b1bffa6c325d6276ead70303472a60f0a17c5.tar.gz
exiftool.el-245b1bffa6c325d6276ead70303472a60f0a17c5.tar.lz
exiftool.el-245b1bffa6c325d6276ead70303472a60f0a17c5.zip
Improve formatting.
* el-exiftool.el (el-exiftool-run): Format docstring so that first
  line stands on its own.
(el-exiftool-command): Format docstring so that first line stands on
its own.
(el-exiftool-read): Format docstring so that first line stands on its
own.

Apropos only displays the first line of the docstring. Hence the first
line must stand on its own.
-rw-r--r--el-exiftool.el18
1 files changed, 9 insertions, 9 deletions
diff --git a/el-exiftool.el b/el-exiftool.el
index d72022f..789269c 100644
--- a/el-exiftool.el
+++ b/el-exiftool.el
@@ -27,19 +27,20 @@
     response))
 
 (defun el-exiftool-run ()
-  "Start an exiftool process if not already running. If an exiftool
-process is already running, delete it, and create a new one. Return
-the process object of the newly created process."
+  "Start an exiftool process if one is not already running.
+If an exiftool process is already running, delete it, and create
+a new one. Return the process object of the newly created
+process."
   (when-let (exiftool (get-process "exiftool"))
     (delete-process exiftool))
   (start-process "exiftool" "exiftool" "exiftool" "-stay_open" "True" "-@" "-"))
 
 (let ((tq (tq-create (el-exiftool-run))))
   (defun el-exiftool-command (&rest args)
-    "Execute a command in the currently running exiftool process. If
-there is no running exiftool process, a new one will be created. ARGS
-are arguments of the command to be run, as provided to the exiftool
-command line application."
+    "Execute a command in the currently running exiftool process.
+If there is no running exiftool process, a new one will be
+created. ARGS are arguments of the command to be run, as provided
+to the exiftool command line application."
     (string-trim
      (let ((suffix "{ready}\n"))
        (string-remove-suffix
@@ -49,8 +50,7 @@ command line application."
 		suffix))))))
 
 (defun el-exiftool-read (file &rest tags)
-  "Read TAGs from FILE, and return an alist mapping tag names to
-corresponding values.
+  "Read TAGs from FILE, and return an alist mapping tag names to corresponding values.
 
 \(fn FILE TAG...)"
   (mapcar