X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;f=emacs%2Frstdoc.el;h=63fa2794c08c176ef116611e5d4d8fca0cda9a86;hb=2156517d902e6013463a5f5f79225741e7f54307;hp=2af91186863db5804f3ebd0ac653fcdfd8c427c0;hpb=a4617f29ce81e7ae3e0cb747fdb9070f88407a28;p=notmuch

diff --git a/emacs/rstdoc.el b/emacs/rstdoc.el
index 2af91186..63fa2794 100644
--- a/emacs/rstdoc.el
+++ b/emacs/rstdoc.el
@@ -24,7 +24,6 @@
 ;;
 
 ;;; Commentary:
-;;
 
 ;; Rstdoc provides a facility to extract all of the docstrings defined in
 ;; an elisp source file. Usage:
@@ -33,14 +32,12 @@
 
 ;;; Code:
 
-(provide 'rstdoc)
-
 (defun rstdoc-batch-extract ()
-  "Extract docstrings to and from the files on the command line"
+  "Extract docstrings to and from the files on the command line."
   (apply #'rstdoc-extract command-line-args-left))
 
 (defun rstdoc-extract (in-file out-file)
-  "Write docstrings from IN-FILE to OUT-FILE"
+  "Write docstrings from IN-FILE to OUT-FILE."
   (load-file in-file)
   (let* ((definitions (cdr (assoc (expand-file-name in-file) load-history)))
 	 (doc-hash (make-hash-table :test 'eq)))
@@ -68,11 +65,11 @@
   (insert "\n"))
 
 (defvar rst--escape-alist
-  '( ("\\\\='" . "\\\\'")
-     ("\\([^\\]\\)'" . "\\1`")
-     ("^[[:space:]\t]*$" . "|br|")
-     ("^[[:space:]\t]" . "|indent| "))
-    "list of (regex . replacement) pairs")
+  '(("\\\\='" . "\\\\'")
+    ("\\([^\\]\\)'" . "\\1`")
+    ("^[[:space:]\t]*$" . "|br|")
+    ("^[[:space:]\t]" . "|indent| "))
+  "List of (regex . replacement) pairs.")
 
 (defun rstdoc--rst-quote-string (str)
   (with-temp-buffer
@@ -83,4 +80,6 @@
 	(replace-match (cdr pair))))
     (buffer-substring (point-min) (point-max))))
 
+(provide 'rstdoc)
+
 ;;; rstdoc.el ends here