[AUCTeX-diffs] [elpa] externals/auctex 9a42bf4 29/71: ; Minor doc fixes

[Tassilo Horn]

branch: externals/auctex
commit 9a42bf4787e4e951ae559442b8729d3cdba0c651
Author: Ikumi Keita <ikumi@ikumi.que.jp>
Commit: Ikumi Keita <ikumi@ikumi.que.jp>

    ; Minor doc fixes
    
    * doc/auctex.texi (Outline):
    * doc/preview-problems.texi (x-symbol interoperation):
    Fix markups.
    * doc/todo.texi (Mid-term Goals): Add ConTeXt.
    * doc/auctex.texi (Modes and Hooks): Fix mode name.
    * context.el (ConTeXt-unnumbered-section-level): Fix variable name.
    * context-en.el (ConTeXt-setup-list-en,ConTeXt-define-list-en):
    (context-en-mode):
    * context-nl.el (ConTeXt-referencing-list-nl,context-nl-mode):
    * context.el (ConTeXt-referencing-list):
    (ConTeXt-numbered-section-list):
    (ConTeXt-unnumbered-section-list):
    (ConTeXt-numbered-section-hook,ConTeXt-last-unended-start):
    (ConTeXt-environment-menu-entry):
    (ConTeXt-environment-modify-menu-entry):
    (ConTeXt-define-menu-entry,ConTeXt-setup-menu-entry):
    (ConTeXt-referencing-menu-entry):
    (ConTeXt-other-macro-menu-entry):
    (ConTeXt-project-structure-menu):
    (ConTeXt-section-block-menu,context-mode):
    * tex-info.el (Texinfo-mark-section,Texinfo-mark-node):
    (TeX-texinfo-mode):
    * tex.el (TeX-comment-padding-string):
    (TeX-search-forward-comment-start):
    Fix doc strings.
---
 context-en.el             |  8 ++++----
 context-nl.el             |  6 +++---
 context.el                | 34 +++++++++++++++++-----------------
 doc/auctex.texi           |  4 ++--
 doc/preview-problems.texi |  6 +++---
 doc/todo.texi             |  4 ++--
 tex-info.el               |  4 ++--
 tex.el                    |  6 +++---
 8 files changed, 36 insertions(+), 36 deletions(-)

diff --git a/context-en.el b/context-en.el
index d79158c..f4b8fdf 100644
--- a/context-en.el
+++ b/context-en.el
@@ -75,7 +75,7 @@
     "indenting" "label"
     "logo" "overlay"
     "palet" "program" "startstop" "type" "typing")
-  "List of the names of ConTeXt en interface  macro's that define things.")
+  "List of the names of ConTeXt en interface macro's that define things.")
 
 (defvar ConTeXt-setup-list-en
   '("align" "arranging" "background" "backgrounds" "blackrules"
@@ -94,7 +94,7 @@
     "screens" "section" "sectionblock" "sorting" "spacing"
     "subpagenumber" "synonyms" "text" "textrules" "texttexts" "thinrules"
     "tolerance" "top" "toptexts" "type" "typing" "underbar" "whitespace")
-  "List of the names of ConTeXt en interface  macro's that setup things.")
+  "List of the names of ConTeXt en interface macro's that setup things.")
 
 ;; referencing in ConTeXt
 (defvar ConTeXt-referencing-list-en
@@ -208,8 +208,8 @@ Special commands:
 \\{ConTeXt-mode-map}
 
 Entering `context-mode' calls the value of `text-mode-hook',
-then the value of TeX-mode-hook, and then the value
-of context-mode-hook."
+then the value of `TeX-mode-hook', and then the value
+of `ConTeXt-mode-hook'."
   (interactive)
   ;; set the ConTeXt interface
   (setq ConTeXt-current-interface "en")
diff --git a/context-nl.el b/context-nl.el
index 5be65f6..9b49cce 100644
--- a/context-nl.el
+++ b/context-nl.el
@@ -92,7 +92,7 @@
 ;; referencing in ConTeXt
 (defvar ConTeXt-referencing-list-nl
   '("in" "op" "over" "paginareferentie" "tekstreferentie" "referentie")
-  "List of ConTeXt en macro's that are used for referencing."
+  "List of ConTeXt nl macro's that are used for referencing."
 )
 
 (defvar ConTeXt-other-macro-list-nl
@@ -183,8 +183,8 @@ Special commands:
 \\{ConTeXt-mode-map}
 
 Entering `context-mode' calls the value of `text-mode-hook',
-then the value of TeX-mode-hook, and then the value
-of context-mode-hook."
+then the value of `TeX-mode-hook', and then the value
+of `ConTeXt-mode-hook'."
   (interactive)
 
   ;; set the ConTeXt interface
diff --git a/context.el b/context.el
index 4c16eef..656a51f 100644
--- a/context.el
+++ b/context.el
@@ -137,14 +137,14 @@
 ;; Referencing ConTeXt macro's
 
 (defvar ConTeXt-referencing-list ()
-  "Calls ConTeXt-XX-other-macro-list where XX is the current interface.")
+  "Calls ConTeXt-XX-referencing-list where XX is the current interface.")
 
 (defun ConTeXt-referencing-command (what)
   "The ConTeXt macro to call WHAT is itself, no interface specific calls."
   what)
 
 (defun ConTeXt-insert-referencing (what)
-  "Insert the ConTeXt referencing SETUP."
+  "Insert the ConTeXt referencing WHAT."
   (insert TeX-esc (ConTeXt-referencing-command what))
   (newline)
   (indent-according-to-mode)
@@ -353,10 +353,10 @@ section."
         (ConTeXt-up-section (1- arg))))))
 
 (defvar ConTeXt-numbered-section-list ()
-  "ConTeXt-XX-section-list where XX is the current interface.")
+  "ConTeXt-XX-numbered-section-list where XX is the current interface.")
 
 (defvar ConTeXt-unnumbered-section-list ()
-  "ConTeXt-XX-section-list where XX is the current interface.")
+  "ConTeXt-XX-unnumbered-section-list where XX is the current interface.")
 
 (defvar ConTeXt-section-list
   (append ConTeXt-numbered-section-list ConTeXt-unnumbered-section-list)
@@ -388,7 +388,7 @@ section."
 
 (defun ConTeXt-unnumbered-section-level (name)
   "Return the level of the section NAME."
-  (let ((entry (TeX-member name ConTeXt-numbered-section-list
+  (let ((entry (TeX-member name ConTeXt-unnumbered-section-list
                            (function (lambda (a b) (equal a (nth 0 b)))))))
     (if entry
         (nth 1 entry)
@@ -409,7 +409,7 @@ The following variables are set before the hooks are run
 `ConTeXt-level'     - numeric section level, see the documentation of
                       `ConTeXt-section'.
 `ConTeXt-name'      - name of the sectioning command, derived from
-                      `level'.
+                      `ConTeXt-level'.
 `ConTeXt-title'     - The title of the section, default to an empty
                       string.
 `ConTeXt-done-mark' - Position of point afterwards, default nil
@@ -864,8 +864,8 @@ An entry looks like: (\"environment\" . function)")
       (buffer-substring beg (point)))))
 
 (defun ConTeXt-last-unended-start ()
-  "Leave point at the beginning of the last `\\start...'.
-That is unstopped looking from the current cursor."
+  "Leave point at the beginning of the last unstopped `\\start...'.
+Look back from the current cursor."
   (while (and (re-search-backward "\\\\start[a-zA-Z]*\\|\\\\stop[a-zA-Z]*")
               (looking-at "\\\\stop[a-zA-Z]*"))
     (ConTeXt-last-unended-start)))
@@ -1350,20 +1350,20 @@ else.  There might be text before point."
 (defvar ConTeXt-environment-menu-name "Insert Environment   (C-c C-e)")
 
 (defun ConTeXt-environment-menu-entry (entry)
-  "Create an entry for the environment menu."
+  "Create an ENTRY for the environment menu."
   (vector (car entry) (list 'ConTeXt-environment-menu (car entry)) t))
 
 (defvar ConTeXt-environment-modify-menu-name "Change Environment   (C-u C-c 
C-e)")
 
 (defun ConTeXt-environment-modify-menu-entry (entry)
-  "Create an entry for the change environment menu."
+  "Create an ENTRY for the change environment menu."
   (vector (car entry) (list 'ConTeXt-modify-environment (car entry)) t))
 
 ;; ConTeXt define macros
 (defvar ConTeXt-define-menu-name "Define")
 
 (defun ConTeXt-define-menu-entry (entry)
-  "Create an entry for the define menu."
+  "Create an ENTRY for the define menu."
   (vector entry (list 'ConTeXt-define-menu entry)))
 
 (defun ConTeXt-define-menu (define)
@@ -1374,7 +1374,7 @@ else.  There might be text before point."
 (defvar ConTeXt-setup-menu-name "Setup")
 
 (defun ConTeXt-setup-menu-entry (entry)
-  "Create an entry for the setup menu."
+  "Create an ENTRY for the setup menu."
   (vector entry (list 'ConTeXt-setup-menu entry)))
 
 (defun ConTeXt-setup-menu (setup)
@@ -1385,7 +1385,7 @@ else.  There might be text before point."
 (defvar ConTeXt-referencing-menu-name "Referencing")
 
 (defun ConTeXt-referencing-menu-entry (entry)
-  "Create an entry for the referencing menu."
+  "Create an ENTRY for the referencing menu."
   (vector entry (list 'ConTeXt-referencing-menu entry)))
 
 (defun ConTeXt-referencing-menu (referencing)
@@ -1396,7 +1396,7 @@ else.  There might be text before point."
 (defvar ConTeXt-other-macro-menu-name "Other macro")
 
 (defun ConTeXt-other-macro-menu-entry (entry)
-  "Create an entry for the other macro menu."
+  "Create an ENTRY for the other macro menu."
   (vector entry (list 'ConTeXt-other-macro-menu entry)))
 
 (defun ConTeXt-other-macro-menu (other-macro)
@@ -1409,7 +1409,7 @@ else.  There might be text before point."
 (defvar ConTeXt-project-structure-menu-name "Project Structure")
 
 (defun ConTeXt-project-structure-menu (project-structure)
-  "Insert project structure from menu."
+  "Insert PROJECT STRUCTURE from menu."
   (ConTeXt-project-structure
    (let ((l ConTeXt-project-structure-list))
      (- (length l) (length (member project-structure l))))))
@@ -1424,7 +1424,7 @@ else.  There might be text before point."
 (defvar ConTeXt-section-block-menu-name "Section Block")
 
 (defun ConTeXt-section-block-menu (section-block)
-  "Insert section block from menu."
+  "Insert SECTION BLOCK from menu."
   (ConTeXt-section-block section-block))
 
 (defun ConTeXt-section-block-menu-entry (entry)
@@ -1825,7 +1825,7 @@ Special commands:
 
 Entering `context-mode' calls the value of `text-mode-hook',
 then the value of `TeX-mode-hook', and then the value
-of ConTeXt-mode-hook."
+of `ConTeXt-mode-hook'."
   (interactive)
   (context-guess-current-interface)
   (require (intern (concat "context-" ConTeXt-current-interface)))
diff --git a/doc/auctex.texi b/doc/auctex.texi
index e4fc72b..8723bb6 100644
--- a/doc/auctex.texi
+++ b/doc/auctex.texi
@@ -2712,7 +2712,7 @@ expression matching a header, and the second is the level 
of the header.
 A @samp{^} is automatically prepended to the regular expressions in the
 list, so they must match text at the beginning of the line.
 
-See @code{LaTeX-section-list} or @code{ConTeXt-INTERFACE-section-list}
+See @code{LaTeX-section-list} or @code{ConTeXt-@var{interface}-section-list}
 for existing header levels.
 @end defvar
 
@@ -4119,7 +4119,7 @@ functions and hooks.
 @vindex LaTeX-mode-hook
 @findex ams-tex-mode
 @vindex AmS-TeX-mode-hook
-@findex ConTeXt-mode
+@findex context-mode
 @vindex ConTeXt-mode-hook
 @findex texinfo-mode
 @vindex Texinfo-mode-hook
diff --git a/doc/preview-problems.texi b/doc/preview-problems.texi
index 282bd1a..e40ff42 100644
--- a/doc/preview-problems.texi
+++ b/doc/preview-problems.texi
@@ -109,16 +109,16 @@ PSTricks, which Dvips would otherwise reserve no space 
for.
 Thanks to the work of Christoph Wedler, starting with version
 @samp{4.0h/beta} of x-symbol, the line parsing of @AUCTeX{} and
 @previewlatex{} is fully supported.  Earlier versions exhibit problems.
-However, versions before 4.2.2 will cause a drastic slowdown of
+However, versions before @samp{4.2.2} will cause a drastic slowdown of
 @previewlatex{}'s parsing pass, so we don't recommend to use versions
 earlier than that.
 
 If you wonder what x-symbol is, it is a package that transforms various
 tokens and subscripts to a more readable form while editing and offers a
 few input methods handy especially for dealing with math. Take a look at
-@uref{http://x-symbol.sourceforge.net}.
+@uref{http://x-symbol.sourceforge.net/}.
 
-x-symbol versions up to 4.5.1-beta at least require an 8bit-clean @TeX{}
+x-symbol versions up to @samp{4.5.1-beta} at least require an 8bit-clean @TeX{}
 implementation (meaning that its terminal output should not use
 @samp{^^}-started escape sequences) for cooperation with
 @previewlatex{}.  Later versions may get along without it, like
diff --git a/doc/todo.texi b/doc/todo.texi
index 5172e54..b83fe5f 100644
--- a/doc/todo.texi
+++ b/doc/todo.texi
@@ -74,8 +74,8 @@ As of @AUCTeX{} 12.3, @code{TeX-remove-style} is no longer 
used by any
 other codes.
 
 @item
-Document @code{LaTeX-insert-into-commments} and
-@code{TeX-translate-location-hook}.
+Document @code{LaTeX-insert-into-commments},
+@code{TeX-translate-location-hook}, and usage of @ConTeXt{} mode.
 @end itemize
 
 @node Wishlist
diff --git a/tex-info.el b/tex-info.el
index 389175d..a317014 100644
--- a/tex-info.el
+++ b/tex-info.el
@@ -197,7 +197,7 @@ structuring commands matched by regexp in variable
 of variable `texinfo-section-list'.
 
 If optional argument NO-SUBSECTION is set to any integer or is a
-non nil empty argument (i.e. `C-u \\[Texinfo-mark-section]'),
+non nil empty argument (i.e. `\\[universal-argument] 
\\[Texinfo-mark-section]'),
 then mark the current section with exclusion of any subsections.
 
 Otherwise, any included subsections are also marked along with
@@ -643,7 +643,7 @@ is assumed by default."
 Special commands:
 \\{Texinfo-mode-map}
 
-Entering Texinfo mode calls the value of `text-mode-hook'  and then the
+Entering Texinfo mode calls the value of `text-mode-hook' and then the
 value of `Texinfo-mode-hook'."
   (interactive)
   (kill-all-local-variables)
diff --git a/tex.el b/tex.el
index 32c4a53..70a6d4a 100644
--- a/tex.el
+++ b/tex.el
@@ -5357,7 +5357,7 @@ and can use regexps instead of syntax."
   (comment-forward n))
 
 (defun TeX-comment-padding-string ()
-  "Return  comment padding as a string.
+  "Return comment padding as a string.
 The variable `comment-padding' can hold an integer or a string.
 This function will return the appropriate string representation
 regardless of its data type."
@@ -5675,8 +5675,8 @@ If LIMIT is omitted, search till the end of the buffer.
 The search relies on `TeX-comment-start-regexp' being set
 correctly for the current mode.
 
-Set `TeX-search-forward-comment-start-defun' in order to override
-the default implementation."
+Set `TeX-search-forward-comment-start-function' in order to
+override the default implementation."
   (if TeX-search-forward-comment-start-function
       (funcall TeX-search-forward-comment-start-function limit)
     (setq limit (or limit (point-max)))