[elpa] externals/transcribe bcba1e3 22/27: Fix some quoting problems in doc strings

[Stefan Monnier]

branch: externals/transcribe
commit bcba1e36f554434cc74182e9311a8e8b09c89078
Author: Paul Eggert <eggert@cs.ucla.edu>
Commit: Paul Eggert <eggert@cs.ucla.edu>

    Fix some quoting problems in doc strings
    
    Most of these are minor issues involving, e.g., quoting `like this'
    instead of 'like this'.  A few involve escaping ` and ' with a
    preceding \= when the characters should not be turned into curved single
    quotes.
---
 transcribe.el | 106 +++++++++++++++++++++++++++++-----------------------------
 1 file changed, 53 insertions(+), 53 deletions(-)

diff --git a/transcribe.el b/transcribe.el
index 983217b..48497b4 100644
--- a/transcribe.el
+++ b/transcribe.el
@@ -22,8 +22,8 @@
 
 ;; REQUIRES:
 ;; -----------------------------
-;; This module works without any requires, but in order to use the audio 
-;; functions, you need to install the Emacs package "emms", by Joe Drew, 
+;; This module works without any requires, but in order to use the audio
+;; functions, you need to install the Emacs package "emms", by Joe Drew,
 ;; and the external program "mpg321", by Jorgen Schafer and Ulrik Jensen,
 ;; both under GPL licenses.
 ;;
@@ -31,35 +31,35 @@
 ;; -------------------------
 ;; Transcribe is a tool to make audio transcriptions for discourse analysis
 ;; in the classroom.
-;; It allows the transcriber to control the audio easily while typing, as well 
as 
-;; automate the insertion of xml tags, in case the transcription protocol 
+;; It allows the transcriber to control the audio easily while typing, as well 
as
+;; automate the insertion of xml tags, in case the transcription protocol
 ;; include them.
-;; The analysis functions will search for a specific structure 
-;; of episodes that can be automatically added with the macro NewEpisode. 
-;; The function expects the speech acts to be transcribed inside a turn xml 
+;; The analysis functions will search for a specific structure
+;; of episodes that can be automatically added with the macro NewEpisode.
+;; The function expects the speech acts to be transcribed inside a turn xml
 ;; tag with the identifier of the speaker with optional move attribute.
-;; Each speech act is spected inside a <l1> or <l2> tag, depending 
-;; on the language used by the person. The attributes expected are the 
-;; number of clauses that form the utterance, the number of errors the 
+;; Each speech act is spected inside a <l1> or <l2> tag, depending
+;; on the language used by the person. The attributes expected are the
+;; number of clauses that form the utterance, the number of errors the
 ;; transcriber observes, and the function of the speech act. The parser will
 ;; work even if some attributes are missing.
-;; 
-;; 
+;;
+;;
 ;; AUDIO COMMANDS
 ;; ------------------------------
-;;     C-x C-p ------> Play audio file. You will be prompted for the name 
+;;     C-x C-p ------> Play audio file. You will be prompted for the name
 ;;                     of the file. The recommended format is mp2.
 ;;     <f5> ---------> Pause or play audio.
 ;;     C-x <right> --> seek audio 10 seconds forward.
 ;;     C-x <left> --->seek audio 10 seconds backward.
-;;     <f8> ---------> seek interactively: positive seconds go forward and 
+;;     <f8> ---------> seek interactively: positive seconds go forward and
 ;;                       negative seconds go backward
 ;;
 ;; XML TAGGING COMMANDS
 ;; --------------------------------------------------
-;;     C-x C-n ------> Create new episode structure. This is useful in case 
your 
+;;     C-x C-n ------> Create new episode structure. This is useful in case 
your
 ;;                 xml file structure requires it.
-;;     <f2> ---------> Interactively insert a function attribute in a speech 
act 
+;;     <f2> ---------> Interactively insert a function attribute in a speech 
act
 ;;                 (l1 or l2) tag.
 ;;     <f3> ---------> Interactively insert a move attribute in a turn 
(person) tag
 ;;     <f4> ---------> Interactively insert an attribute (any kind)
@@ -100,28 +100,28 @@
 ;; (append transcribe-attribute-list transcribe-function-list 
transcribe-move-list)
 
 (defun transcribe-analyze-episode (episode person)
-  "This calls the external python package analyze_episodes2.py. The new 
+  "This calls the external python package analyze_episodes2.py. The new
    function transcribe-analyze implements its role now."
   (interactive "sepisode: \nsperson:")
-  (shell-command (concat (expand-file-name  "analyze_episodes2.py") 
+  (shell-command (concat (expand-file-name  "analyze_episodes2.py")
                   " -e " episode " -p " person " -i " buffer-file-name )))
 
 (defun transcribe-raw-to-buffer ()
   "EXPERIMENTAL - Convert the xml tagged transcription to raw transcription, 
with the names
    and the persons and the utterances only. The raw transcription will be send 
to buffer called
-   'Raw Output'"
+   `Raw Output'."
   (interactive)
   (let* ((xml (xml-parse-region (point-min) (point-max)))
     (results (car xml))
     (episodes (xml-get-children results 'episode)))
-   
+
     (dolist (episode episodes)
       (let* ((transcription (xml-get-children episode 'transcription)))
-   
+
         (dolist (turn transcription)
           (dolist (intervention (xml-node-children turn))
             (if (listp intervention)
-              (progn 
+              (progn
                 (with-current-buffer "Raw Output"
                   (insert (format "%s\t" (line-number-at-pos)))
                   (insert (format "%s:\t" (car intervention)))
@@ -131,17 +131,17 @@
                          (insert (format "%s "  (nth 2 utterance))))
 
                          (insert (format "%s" utterance))))))
-                        
+
                        (with-current-buffer "Raw Output"
                          (insert (format "%s" (line-number-at-pos)))
                          (insert (format "%s" intervention))))))))))
 
 (defun transcribe-analyze (episodenumber personid)
-  "Extract from a given episode and person the number of asunits per 
+  "Extract from a given episode and person the number of asunits per
    second produced, and the number of clauses per asunits, for L2 and L1.
    It writes two output files, one for L2 utterances and one for L1
    utterances, so that they can be used with external programs. Output will
-   be inserted in 'Statistics Output' buffer"
+   be inserted in `Statistics Output' buffer."
   (interactive "sepisodenumber: \nspersonid:")
   (let* ((interventionsl2 '())
      (interventionsl1 '())
@@ -166,18 +166,18 @@
      (demand nil)
      ;; (clausesmessage nil)
      (number nil))
-         
+
      (dolist (episode episodes)
        (let*((numbernode (xml-get-children episode 'number))
          (tasknode (xml-get-children episode 'task)))
-                 
+
          (setq number (nth 2 (car numbernode)))
          (when (equal episodenumber number)
            (let* ((durationnode (xml-get-children episode 'duration))
              (transcription (xml-get-children episode 'transcription)))
-                       
+
              (setq duration (nth 2 (car durationnode)))
-             
+
              (dolist (task tasknode)
               (let* ((rolenode (xml-get-children task 'role))
                 (contextnode (xml-get-children task 'context))
@@ -191,20 +191,20 @@
                 ))
 
              (dolist (turn transcription)
-               (let* ((interventionnode (xml-get-children turn 
+               (let* ((interventionnode (xml-get-children turn
                  (intern personid))))
-                 
+
                  (dolist (intervention interventionnode)
                    (let* ((l2node (xml-get-children intervention 'l2))
                      (l1node (xml-get-children intervention 'l1)))
-                       
+
                      (dolist (l2turn l2node)
                        (let* ((l2 (nth 2 l2turn))
                           (attrs (nth 1 l2turn))
                           (clausesl2nodeinc (cdr (assq 'clauses attrs)))
                           (errorsl2inc (cdr (assq 'errors attrs)))
                           (function (cdr (assq 'function attrs))))
-                          
+
                           (when (string-equal function "initiating")
                             (setq initiating (+ initiating 1)))
                           (when (string-equal function "responding")
@@ -216,25 +216,25 @@
                           (when (string-equal function "interpersonal")
                             (setq interpersonal (+ interpersonal 1)))
                           (when attrs
-                            (setq clausesl2 (+ clausesl2 (string-to-number 
+                            (setq clausesl2 (+ clausesl2 (string-to-number
                              clausesl2nodeinc)))
                             (setq errorsl2 (+ errorsl2 (string-to-number
                              errorsl2inc))))
-                          (when l2 
+                          (when l2
                             ;; (add-to-list 'interventionsl2 l2)
-                            (cl-pushnew l2 interventionsl2 :test #'equal) 
+                            (cl-pushnew l2 interventionsl2 :test #'equal)
                             (setq asunitsl2 (1+ asunitsl2)))))
                      (dolist (l1turn l1node)
                        (let*((l1 (nth 2 l1turn))
                          (clausesl1node (nth 1 l1turn))
                          (clausesl1nodeinc (cdr (car clausesl1node))))
-                         
+
                          (when (not (equal clausesl1node nil))
-                           (setq clausesl1 (+ clausesl1 (string-to-number 
+                           (setq clausesl1 (+ clausesl1 (string-to-number
                               clausesl1nodeinc))))
-                         (when l1 
+                         (when l1
                            ;; (add-to-list 'interventionsl1 l1)
-                           (cl-pushnew l1 interventionsl1 :test #'equal) 
+                           (cl-pushnew l1 interventionsl1 :test #'equal)
                            (setq asunitsl1 (1+ asunitsl1)))))))))))))
   (reverse interventionsl2)
   ;; (write-region (format "%s" interventionsl2) nil (format 
"transcribe-output-%s-%s-l2.txt" episodenumber personid))
@@ -252,24 +252,24 @@
     (controlperasunitl2 (/ control asunitsl2))
     (expressiveperasunitl2 (/ expressive asunitsl2))
     (interpersonalperasunitl2 (/ interpersonal asunitsl2)))
-  
+
     ;; (princ clausesmessage)
     (princ (format "episode: %s, duration: %s, person: %s\n" episodenumber 
duration personid))
-    (with-current-buffer "Statistics Output" 
+    (with-current-buffer "Statistics Output"
       (insert (format 
"%s,%s,%s,0,0,%s,%s,%s,%s,%s,QUAN-L2,segmented,aux,level,subject,yearofclil,month\n"
 personid episodenumber duration role context demand asunitspersecondl2 
asunitspersecondl1)))
-    (princ (format "L2(Asunits/second): %s, L2(clauses/Asunit): %s, 
L2(errors/Asunit):%s, L1(Asunits/second): %s\n" 
+    (princ (format "L2(Asunits/second): %s, L2(clauses/Asunit): %s, 
L2(errors/Asunit):%s, L1(Asunits/second): %s\n"
           asunitspersecondl2 clausesperasunitl2 errorsperasunitl2 
asunitspersecondl1))
     (princ (format "Functions/unit: Initiating: %s, Responding: %s, Control: 
%s, Expressive: %s, Interpersonal: %s" initiatingperasunitl2 
respondingperasunitl2 controlperasunitl2 expressiveperasunitl2 
interpersonalperasunitl2)))))
 
 (defun transcribe-analyze-all ()
-  "Analyze all file and output to 'Statistics Output' buffer. The buffer will
+  "Analyze all file and output to `Statistics Output' buffer. The buffer will
    lost all previous data. The data in the buffer can be saved to a file and be
-   passed to 'R' for statistical analysis."
+   passed to R for statistical analysis."
   (interactive)
   (let* ((xml (xml-parse-region (point-min) (point-max)))
      (results (car xml))
      (episodes (xml-get-children results 'episode)))
-  
+
      (with-current-buffer "Statistics Output"
        (erase-buffer)
        (insert 
"person,episode,duration,C-UNITS(L2),C-UNITS(L1),role,context,demand,QUAN-L2,QUAN-L1,QUAL-L2,segmented,aux,level,subjects,yearofCLIL,month\n"))
@@ -280,8 +280,8 @@
          (number (nth 2 (car numbernode)))
          (participantsstring (nth 2 (car participantsnode)))
          (participants (split-string participantsstring)))
-           
-         (dolist (participant participants) 
+
+         (dolist (participant participants)
            (transcribe-analyze number participant))))))
 
 
@@ -311,17 +311,17 @@
 
 (defun transcribe-add-attribute (att val)
   "Adds a xml attribute at cursor with the name and value specified 
(autocompletion possible)"
-  (interactive (list(completing-read "attibute name:" 
transcribe-attribute-list)(read-string "value:"))) 
+  (interactive (list(completing-read "attibute name:" 
transcribe-attribute-list)(read-string "value:")))
   (insert (format "%s=\"%s\"" att val)))
 
 (defun transcribe-add-attribute-function (val)
-  "Adds the xml attribute 'function' at cursor with the name specified 
(autocompletion possible)"
-  (interactive (list(completing-read "function name:" 
transcribe-function-list))) 
+  "Adds the xml attribute `function' at cursor with the name specified 
(autocompletion possible)"
+  (interactive (list(completing-read "function name:" 
transcribe-function-list)))
   (insert (format "function=\"%s\"" val)))
 
 (defun transcribe-add-attribute-move (val)
-  "Adds the xml attribute 'move' at cursor with the name specified 
(autocompletion possible"
-  (interactive (list(completing-read "move name:" transcribe-move-list))) 
+  "Adds the xml attribute `move' at cursor with the name specified 
(autocompletion possible"
+  (interactive (list(completing-read "move name:" transcribe-move-list)))
   (insert (format "move=\"%s\"" val)))
 
 (defun transcribe-xml-tag-l1 ()