emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/auctex 0376fd2 32/71: ; Fix doc strings


From: Tassilo Horn
Subject: [elpa] externals/auctex 0376fd2 32/71: ; Fix doc strings
Date: Fri, 17 Dec 2021 15:00:31 -0500 (EST)

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

    ; Fix doc strings
    
    * context.el (ConTeXt-project-structure-menu):
    (ConTeXt-section-block-menu,ConTeXt-clean-intermediate-suffixes):
    (ConTeXt-clean-output-suffixes):
    * font-latex.el (font-latex-user-keyword-classes):
    (font-latex-fontify-script,font-latex-update-font-lock):
    * latex.el (LaTeX-verbatim-environments-local):
    (LaTeX-insert-ampersands,LaTeX-provided-class-options):
    (LaTeX-provided-package-options,TeX-read-label):
    (LaTeX-indent-comment-start-regexp,LaTeX-back-to-indentation):
    (LaTeX-fill-paragraph,LaTeX-paragraph-commands-regexp-make):
    (LaTeX-math-list,docTeX-clean-intermediate-suffixes):
    (LaTeX-clean-intermediate-suffixes,LaTeX-hanging-ampersand-position):
    * plain-tex.el (plain-TeX-clean-intermediate-suffixes):
    (AmSTeX-clean-intermediate-suffixes):
    * style/amsthm.el (LaTeX-amsthm-env-label):
    * style/kpfonts.el (LaTeX-kpfonts-default):
    * style/ntheorem.el (LaTeX-ntheorem-env-label):
    * style/tcolorbox.el (LaTeX-tcolorbox-load-used-libraries):
    * style/theorem.el (LaTeX-theorem-env-label):
    * style/thmtools.el (LaTeX-thmtools-env-label):
    * tex-buf.el (TeX-command-region,TeX-TeX-sentinel-check):
    (TeX-process-set-variable,TeX-current-process-region-p):
    (TeX-command-run-all,TeX-error-list):
    (TeX-error-description-list-local):
    * tex-fold.el (TeX-fold-macro-spec-list-internal):
    (TeX-fold-env-spec-list-internal,TeX-fold-math-spec-list-internal):
    * tex-info.el (Texinfo-mark-section):
    (Texinfo-clean-intermediate-suffixes):
    (Texinfo-clean-output-suffixes):
    * tex-jp.el (japanese-TeX-error-messages):
    * tex.el (TeX-near-bobp,TeX--list-of-string-p):
    (TeX-source-correlate-start-server-flag):
    (TeX-style-hook-dialect,TeX-insert-macro-default-style):
    (TeX-in-line-comment,TeX-find-closing-brace):
    (TeX-find-opening-brace,TeX-doc-backend-alist):
    * texmathp.el (texmathp-why):
    Fix doc strings, following `(elisp) Documentation Tips'.
---
 context.el         |  8 ++++----
 font-latex.el      | 12 ++++++------
 latex.el           | 53 +++++++++++++++++++++++++++--------------------------
 plain-tex.el       |  8 ++++----
 style/amsthm.el    |  2 +-
 style/kpfonts.el   |  6 +++---
 style/ntheorem.el  |  2 +-
 style/tcolorbox.el |  2 +-
 style/theorem.el   |  2 +-
 style/thmtools.el  |  2 +-
 tex-buf.el         | 16 ++++++++--------
 tex-fold.el        |  6 +++---
 tex-info.el        |  6 +++---
 tex-jp.el          |  2 +-
 tex.el             | 18 +++++++++---------
 texmathp.el        |  4 ++--
 16 files changed, 75 insertions(+), 74 deletions(-)

diff --git a/context.el b/context.el
index 656a51f..1396635 100644
--- a/context.el
+++ b/context.el
@@ -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)
@@ -1698,7 +1698,7 @@ file, or any mode derived thereof. See variable
     "-mprun\\.mp" "-mprun\\.mpd" "-mprun\\.mpo" "-mprun\\.mpy")
   "List of regexps matching suffixes of files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
@@ -1706,7 +1706,7 @@ i.e. you do _not_ have to cater for this yourself by 
adding \\\\' or $."
   '("\\.dvi" "\\.pdf" "\\.ps")
   "List of regexps matching suffixes of files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
diff --git a/font-latex.el b/font-latex.el
index 18c04d5..6fab896 100644
--- a/font-latex.el
+++ b/font-latex.el
@@ -733,9 +733,9 @@ keywords, a face and a specifier for the type of macro to be
 highlighted.
 
 When adding new entries, you have to use unique values for the
-class names, i.e. they must not clash with names of the built-in
-keyword classes or other names given by you.  Additionally the
-names must not contain spaces.
+class names, that is, they must not clash with names of the
+built-in keyword classes or other names given by you.
+Additionally the names must not contain spaces.
 
 The list of keywords defines which commands and declarations
 should be covered by the keyword class.  A keyword can either be
@@ -918,8 +918,8 @@ locking machinery will be triggered."
 
 By default, super/subscripts are raised/lowered if this variable
 is non-nil.  This fontification only affects one level of
-scripts, e.g., in x^{y^z}, the y and the z have the same size and
-are equally raised over x.
+scripts, for example in x^{y^z}, the y and the z have the same
+size and are equally raised over x.
 
 If this variable is set to the symbol `multi-level', then y is
 raised above x, and z is raised above y.  With many script
@@ -1316,7 +1316,7 @@ If SYNTACTIC-KWS is non-nil, also update
 It is obsolete and going to be removed.
 If you have called `font-latex-add-keywords' and want to refresh fontification,
 call `font-lock-flush' instead.
-If you changed syntactic fontification, e.g., one of the variables
+If you changed syntactic fontification, for example, one of the variables
 - `LaTeX-verbatim-macros-with-delims'
 - `LaTeX-verbatim-macros-with-delims-local'
 - `LaTeX-verbatim-macros-with-braces'
diff --git a/latex.el b/latex.el
index afd4190..0523834 100644
--- a/latex.el
+++ b/latex.el
@@ -1524,7 +1524,7 @@ The number is calculated from REGEXP and FUNC.
 Example 1:
 Consider the case that the current environment begins with
 \\begin{array}[t]{|lcr|}
-.  REGEXP must be chosen to match \"[t]\", i.e., the text between just
+.  REGEXP must be chosen to match \"[t]\", that is, the text between just
 after \"\\begin{array}\" and just before \"{|lcr|}\", which encloses
 the column specification.  FUNC must return the number of ampersands to
 be inserted, which is 2 since this example specifies three columns.
@@ -1818,7 +1818,7 @@ The input string may include LaTeX comments and newlines."
 For each element, the CAR is the name of the class, the CDR is
 the list of options provided to it.
 
-E.g., its value will be
+For example, its value will be
   \(\(\"book\" \"a4paper\" \"11pt\" \"openany\" \"fleqn\"\)
    ...\)
 See also `LaTeX-provided-package-options'.")
@@ -1841,7 +1841,7 @@ Return first found class option matching REGEXP, or nil 
if not found."
 For each element, the CAR is the name of the package, the CDR is
 the list of options provided to it.
 
-E.g., its value will be
+For example, its value will be
   \(\(\"babel\" \"german\"\)
    \(\"geometry\" \"a4paper\" \"top=2cm\" \"bottom=2cm\" \"left=2.5cm\" 
\"right=2.5cm\"\)
    ...\)
@@ -2037,13 +2037,14 @@ argument, otherwise as a mandatory one."
   "Prompt for a label completing with known labels and return it.
 This function always returns a string depending on user input:
 the returned value can be an empty string \"\", the value of
-`TeX-read-label-prefix' if present (e.g. \"fig:\") or a complete
-label input (e.g. \"fig:foo\").  If OPTIONAL is non-nil, indicate
-optional as part of prompt in minibuffer.  Use PROMPT as the
-prompt string.  If DEFINITION is non-nil, add the chosen label to
-the list of defined labels.  `TeX-read-label-prefix' is used as
-initial input for the label.  Also check if label is already
-defined and ask user for confirmation before proceeding."
+`TeX-read-label-prefix' if present (for example, \"fig:\") or a
+complete label input (for example, \"fig:foo\").  If OPTIONAL is
+non-nil, indicate optional as part of prompt in minibuffer.  Use
+PROMPT as the prompt string.  If DEFINITION is non-nil, add the
+chosen label to the list of defined labels.
+`TeX-read-label-prefix' is used as initial input for the label.
+Also check if label is already defined and ask user for
+confirmation before proceeding."
   (let (label valid)
     (while (not valid)
       (setq label
@@ -3375,7 +3376,7 @@ buffer-local keyword additions via
   :type '(repeat (string)))
 
 (defvar LaTeX-verbatim-environments-local nil
-  "Buffer-local variable for inline verbatim environments.
+  "Buffer-local variable for verbatim environments.
 
 Style files should add constructs to this variable and not to
 `LaTeX-verbatim-environments'.
@@ -3594,8 +3595,8 @@ This means, we just count the LaTeX tokens \\left, 
\\right, \\begin,
 and \\end up to the first occurence of text matching this regexp.
 Thus, the default \"%\" stops counting the tokens at a comment.  A
 value of \"%[^>]\" would allow you to alter the indentation with
-comments, e.g. with comment `%> \\begin'.
-Lines which start with `%' are not considered at all, regardless if this
+comments, for example with comment `%> \\begin'.
+Lines which start with `%' are not considered at all, regardless of this
 value."
   :group 'LaTeX-indentation
   :type 'regexp)
@@ -3928,7 +3929,7 @@ outer indentation in case of a commented line.  The 
symbols
 If it is commented and comments are formatted syntax-aware move
 point to the first non-whitespace character after the comment
 character(s), but only if `this-command' is not a newline
-command, i.e., `TeX-newline' or the value of
+command, that is, `TeX-newline' or the value of
 `TeX-newline-function'.  The optional argument FORCE-TYPE can be
 used to force point being moved to the inner or outer indentation
 in case of a commented line.  The symbols 'inner and 'outer are
@@ -4473,7 +4474,7 @@ space does not end a sentence, so don't break a line 
there."
 (defun LaTeX-fill-paragraph (&optional justify)
   "Like `fill-paragraph', but handle LaTeX comments.
 If any of the current line is a comment, fill the comment or the
-paragraph of it that point is in.  Code comments, i.e. comments
+paragraph of it that point is in.  Code comments, that is, comments
 with uncommented code preceding them in the same line, will not
 be filled unless the cursor is placed on the line with the
 code comment.
@@ -4841,7 +4842,7 @@ value of NO-SUBSECTIONS."
 (defun LaTeX-paragraph-commands-regexp-make ()
   "Return a regular expression matching defined paragraph commands.
 Regexp part containing TeX control words is postfixed with `\\b'
-to avoid ambiguities (e.g. \\par vs. \\parencite)."
+to avoid ambiguities (for example, \\par vs. \\parencite)."
   (let (cmds symbs)
     (dolist (mac (append LaTeX-paragraph-commands
                          LaTeX-paragraph-commands-internal))
@@ -5684,8 +5685,8 @@ Each entry should be a list with up to four elements, 
KEY, VALUE,
 MENU and CHARACTER.
 
 KEY is the key (after `LaTeX-math-abbrev-prefix') to be redefined
-in math minor mode.  KEY can be a character (e.g. ?o) for a
-single stroke or a string (e.g. \"o a\") for a multi-stroke
+in math minor mode.  KEY can be a character (for example ?o) for a
+single stroke or a string (for example \"o a\") for a multi-stroke
 binding.  If KEY is nil, the symbol has no associated
 keystroke (it is available in the menu, though).  Note that
 predefined keys in `LaTeX-math-default' cannot be overridden in
@@ -5698,9 +5699,9 @@ or a function to be called.  The macro must be given 
without the
 leading backslash.
 
 The third element MENU is the name of the submenu where the
-command should be added.  MENU can be either a string
-\(e.g. \"greek\"), a list (e.g. (\"AMS\" \"Delimiters\")) or nil.
-If MENU is nil, no menu item will be created.
+command should be added.  MENU can be either a string (for
+example \"greek\"), a list (for example (\"AMS\" \"Delimiters\"))
+or nil.  If MENU is nil, no menu item will be created.
 
 The fourth element CHARACTER is a Unicode character position for
 menu display.  When nil, no character is shown.
@@ -6827,14 +6828,14 @@ runs the hooks in `docTeX-mode-hook'."
   TeX-clean-default-intermediate-suffixes
   "List of regexps matching suffixes of files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
 (defcustom docTeX-clean-output-suffixes TeX-clean-default-output-suffixes
   "List of regexps matching suffixes of files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
@@ -6844,14 +6845,14 @@ i.e. you do _not_ have to cater for this yourself by 
adding \\\\' or $."
           '("\\.acn" "\\.acr" "\\.alg" "\\.glg" "\\.ist"))
   "List of regexps matching suffixes of files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
 (defcustom LaTeX-clean-output-suffixes TeX-clean-default-output-suffixes
   "List of regexps matching suffixes of files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
@@ -7575,7 +7576,7 @@ function would return non-nil and `(match-string 1)' 
would return
     (cons (point) (current-column))))
 
 (defun LaTeX-hanging-ampersand-position ()
-  "Return indent column for a hanging ampersand (i.e. ^\\s-*&)."
+  "Return indent column for a hanging ampersand (that is, ^\\s-*&)."
   (cl-destructuring-bind
       (beg-pos . beg-col)
       (LaTeX-env-beginning-pos-col)
diff --git a/plain-tex.el b/plain-tex.el
index 4c384f0..0d43fdb 100644
--- a/plain-tex.el
+++ b/plain-tex.el
@@ -254,14 +254,14 @@ of `plain-TeX-mode-hook'."
   TeX-clean-default-intermediate-suffixes
   "List of regexps matching suffixes of intermediate files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
 (defcustom plain-TeX-clean-output-suffixes TeX-clean-default-output-suffixes
   "List of regexps matching suffixes of output files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
@@ -315,14 +315,14 @@ of `AmS-TeX-mode-hook'."
   TeX-clean-default-intermediate-suffixes
   "List of regexps matching suffixes of intermediate files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
 (defcustom AmSTeX-clean-output-suffixes TeX-clean-default-output-suffixes
   "List of regexps matching suffixes of output files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
diff --git a/style/amsthm.el b/style/amsthm.el
index 866951a..3ea8176 100644
--- a/style/amsthm.el
+++ b/style/amsthm.el
@@ -80,7 +80,7 @@ for label.  AUCTeX users should add ENVIRONMENT to
   (add-to-list \\='LaTeX-label-alist \\='(\"lemma\" . \"lem:\"))
 
 RefTeX users should customize or add ENVIRONMENT to
-`LaTeX-label-alist' and `reftex-label-alist', e.g.
+`LaTeX-label-alist' and `reftex-label-alist', for example
 
   (add-to-list \\='LaTeX-label-alist \\='(\"lemma\" . \"lem:\"))
   (add-to-list \\='reftex-label-alist
diff --git a/style/kpfonts.el b/style/kpfonts.el
index 8dec44c..f54de64 100644
--- a/style/kpfonts.el
+++ b/style/kpfonts.el
@@ -385,9 +385,9 @@ or a function to be called.  The macro must be given 
without the
 leading backslash.
 
 The third element MENU is the name of the submenu where the
-command should be added.  MENU can be either a string
-\(e.g. \"greek\"\), a list (e.g. \(\"AMS\" \"Delimiters\"\)\) or
-nil.  If MENU is nil, no menu item will be created.
+command should be added.  MENU can be either a string (for
+example \"greek\"), a list (for example (\"AMS\" \"Delimiters\"))
+or nil.  If MENU is nil, no menu item will be created.
 
 The fourth element CHARACTER is a Unicode character position for
 menu display.  When nil, no character is shown.
diff --git a/style/ntheorem.el b/style/ntheorem.el
index 35c4e45..cd8eff4 100644
--- a/style/ntheorem.el
+++ b/style/ntheorem.el
@@ -103,7 +103,7 @@ for label.  AUCTeX users should add ENVIRONMENT to
   (add-to-list \\='LaTeX-label-alist \\='(\"lemma\" . \"lem:\"))
 
 RefTeX users should customize or add ENVIRONMENT to
-`LaTeX-label-alist' and `reftex-label-alist', e.g.
+`LaTeX-label-alist' and `reftex-label-alist', for example
 
   (add-to-list \\='LaTeX-label-alist \\='(\"lemma\" . \"lem:\"))
   (add-to-list \\='reftex-label-alist
diff --git a/style/tcolorbox.el b/style/tcolorbox.el
index c7e7051..0a4445b 100644
--- a/style/tcolorbox.el
+++ b/style/tcolorbox.el
@@ -450,7 +450,7 @@ This functions checks the arguments of \\tcbuselibrary and 
the
 name of libraries given in the optional argument of \\usepackage
 call for tcolorbox and runs the style hook for them.  The file
 for style must have the prefix \"tcolorboxlib-\" in the name,
-e.g. \"tcolorboxlib-raster.el\"."
+for example \"tcolorboxlib-raster.el\"."
   (when (LaTeX-tcolorbox-tcbuselibrary-list)
     (let (libs)
       (dolist (x (LaTeX-tcolorbox-tcbuselibrary-list))
diff --git a/style/theorem.el b/style/theorem.el
index d844129..d0fd1ff 100644
--- a/style/theorem.el
+++ b/style/theorem.el
@@ -87,7 +87,7 @@ for label.  AUCTeX users should add ENVIRONMENT to
   (add-to-list \\='LaTeX-label-alist \\='(\"lemma\" . \"lem:\"))
 
 RefTeX users should customize or add ENVIRONMENT to
-`LaTeX-label-alist' and `reftex-label-alist', e.g.
+`LaTeX-label-alist' and `reftex-label-alist', for example
 
   (add-to-list \\='LaTeX-label-alist \\='(\"lemma\" . \"lem:\"))
   (add-to-list \\='reftex-label-alist
diff --git a/style/thmtools.el b/style/thmtools.el
index d9ccf19..d17b30e 100644
--- a/style/thmtools.el
+++ b/style/thmtools.el
@@ -225,7 +225,7 @@ customize or in init-file with:
   (add-to-list \\='LaTeX-label-alist \\='(\"theorem\" . \"thm:\"))
 
 RefTeX users should customize or add ENVIRONMENT to
-`LaTeX-label-alist' and `reftex-label-alist', e.g.
+`LaTeX-label-alist' and `reftex-label-alist', for example
 
   (add-to-list \\='LaTeX-label-alist \\='(\"theorem\" . \"thm:\"))
   (add-to-list \\='reftex-label-alist
diff --git a/tex-buf.el b/tex-buf.el
index ceafafe..cdc4b06 100644
--- a/tex-buf.el
+++ b/tex-buf.el
@@ -193,7 +193,7 @@ if present.
 
 If a prefix argument OVERRIDE-CONFIRM is given, prompting will
 ignore the prompting flag from `TeX-command-list' and instead
-will prompt iff the prefix is positive.
+will prompt only if the prefix is positive.
 
 If the master file for the document has a header, it is written to the
 temporary file before the region itself.  The document's header is all
@@ -1513,7 +1513,7 @@ errors or warnings to show."
 
 (defun TeX-TeX-sentinel-check (process name)
   "Cleanup TeX output buffer after running TeX.
-Return nil ifs no errors were found."
+Return nil only if no errors were found."
   (save-excursion
     (goto-char (point-max))
     (cond
@@ -1874,7 +1874,7 @@ defined."
 
 (defun TeX-process-set-variable (name symbol value)
   "Set the variable SYMBOL in the process buffer to VALUE.
-Return nil iff no process buffer exist."
+Return nil only if no process buffer exists."
   (let ((buffer (TeX-process-buffer name)))
     (if buffer
         (with-current-buffer buffer
@@ -2019,7 +2019,7 @@ command."
 ;;; Active Process
 
 (defvar TeX-current-process-region-p nil
-  "This variable is set to t iff the last TeX command is on a region.")
+  "Non-nil means that the last TeX command is on a region.")
 
 (defun TeX-active-process ()
   "Return the active process for the current buffer."
@@ -2354,10 +2354,10 @@ depend on it being positive instead of the entry in
 (defun TeX-command-run-all (arg)
   "Compile the current document until an error occurs or it is finished.
 With a prefix ARG (`\\[universal-argument] \\[TeX-command-run-all]'),
-compile the current region instead, e.g, call
+compile the current region instead, that is, call
 `TeX-command-run-all-region'.  With multiple prefix
 arguments (`\\[universal-argument] \\[universal-argument] 
\\[TeX-command-run-all]'),
-compile the current section instead, e.g. call
+compile the current section instead, that is, call
 `LaTeX-command-run-all-section'."
   (interactive "P")
   (cond
@@ -2518,7 +2518,7 @@ error or warning.  This is the structure of each element:
  *  5: context, to be displayed in the help window
  *  6: string to search in the buffer, in order to find location
        of the error or warning
- *  7: for warnings referring to multiple lines (e.g. bad boxes),
+ *  7: for warnings referring to multiple lines (for exapmle, bad boxes),
        the last line mentioned in the warning message
  *  8: t if it is a bad-box, nil otherwise
  *  9: value of `TeX-error-point'
@@ -2969,7 +2969,7 @@ Major modes of AUCTeX can set its own catalogue as buffer 
local
 value of this variable, as LaTeX mode does.
 Style files of AUCTeX can also add their own entries to buffer local
 value of this variable to provide their own help messages.
-It must end with a fallback entry that matches any error, e.g.
+It must end with a fallback entry that matches any error, for example
 \(\".*\" . \"No help available\")")
 
 ;;; - Help
diff --git a/tex-fold.el b/tex-fold.el
index d5b98d1..ec348b9 100644
--- a/tex-fold.el
+++ b/tex-fold.el
@@ -123,7 +123,7 @@ Customize or reset the mode."
   "Internal list of display strings and macros to fold.
 Is updated when the TeX Fold mode is being activated and then
 contains all constructs to fold for the given buffer or mode
-respectively, i.e. contents of both `TeX-fold-macro-spec-list'
+respectively, that is, contents of both `TeX-fold-macro-spec-list'
 and <mode-prefix>-fold-macro-spec-list.")
 (make-variable-buffer-local 'TeX-fold-macro-spec-list-internal)
 
@@ -138,7 +138,7 @@ and <mode-prefix>-fold-macro-spec-list.")
   "Internal list of display strings and environments to fold.
 Is updated when the TeX Fold mode is being activated and then
 contains all constructs to fold for the given buffer or mode
-respectively, i.e. contents of both `TeX-fold-env-spec-list'
+respectively, that is, contents of both `TeX-fold-env-spec-list'
 and <mode-prefix>-fold-env-spec-list.")
 (make-variable-buffer-local 'TeX-fold-env-spec-list-internal)
 
@@ -152,7 +152,7 @@ and <mode-prefix>-fold-env-spec-list.")
   "Internal list of display strings and math macros to fold.
 Is updated when the TeX Fold mode is being activated and then
 contains all constructs to fold for the given buffer or mode
-respectively, i.e. contents of both `TeX-fold-math-spec-list'
+respectively, that is, contents of both `TeX-fold-math-spec-list'
 and <mode-prefix>-fold-math-spec-list.")
 (make-variable-buffer-local 'TeX-fold-math-spec-list-internal)
 
diff --git a/tex-info.el b/tex-info.el
index a317014..126eb4f 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. `\\[universal-argument] 
\\[Texinfo-mark-section]'),
+non nil empty argument (that is, `\\[universal-argument] 
\\[Texinfo-mark-section]'),
 then mark the current section with exclusion of any subsections.
 
 Otherwise, any included subsections are also marked along with
@@ -873,7 +873,7 @@ value of `Texinfo-mode-hook'."
   '("\\.cps?" "\\.vrs?" "\\.fns?" "\\.tps?" "\\.pgs?" "\\.kys?")
   "List of regexps matching suffixes of files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
@@ -883,7 +883,7 @@ i.e. you do _not_ have to cater for this yourself by adding 
\\\\' or $."
     "_toc\\.html" "_fot\\.html" "_abt\\.html" "_[0-9]+\\.html" "_l2h_img.+")
   "List of regexps matching suffixes of files to be deleted.
 The regexps will be anchored at the end of the file name to be matched,
-i.e. you do _not_ have to cater for this yourself by adding \\\\' or $."
+that is, you do _not_ have to cater for this yourself by adding \\\\' or $."
   :type '(repeat regexp)
   :group 'TeX-command)
 
diff --git a/tex-jp.el b/tex-jp.el
index 562f2c9..714aa7a 100644
--- a/tex-jp.el
+++ b/tex-jp.el
@@ -224,7 +224,7 @@ systems are determined by their values regardless of the 
kanji option."
           '("/usr/share/texmf/jtex/" "/usr/share/texmf/jbibtex/bst/")))
 
 (defcustom japanese-TeX-error-messages t
-  "If non-nil, explain TeX error messages in Japanese."
+  "If non-nil, explain LaTeX error messages in Japanese."
   :type 'boolean)
 
 (defcustom TeX-japanese-process-input-coding-system nil
diff --git a/tex.el b/tex.el
index 968579e..0338bef 100644
--- a/tex.el
+++ b/tex.el
@@ -1696,7 +1696,7 @@ as a string.")
 
 (defvar TeX-source-correlate-start-server-flag nil
   "If non-nil, `TeX-source-correlate-start-server-maybe' will start a server.
-Code related to features requiring a server, e.g. for inverse
+Code related to features requiring a server, for example, for inverse
 search, can set the variable.")
 
 (defun TeX-source-correlate-gnuserv-p ()
@@ -2823,7 +2823,7 @@ Supported values are described below:
 
 Purpose is notably to prevent non-Texinfo hooks to be run in
 Texinfo files, due to ambiguous style name, as this may cause bad
-side effect e.g. on variable `TeX-font-list'.")
+side effect for example on variable `TeX-font-list'.")
 
 (defcustom TeX-byte-compile nil
   "Not nil means try to byte compile auto files before loading."
@@ -3302,7 +3302,7 @@ optional arguments.  If set to `mandatory-args-only',
 When `TeX-insert-macro' is called with \\[universal-argument], it's the other
 way round.
 
-Note that for some macros, there are special mechanisms, see e.g.
+Note that for some macros, there are special mechanisms, see for example
 `LaTeX-includegraphics-options-alist' and `TeX-arg-cite-note-p'."
   :group 'TeX-macro
   :type '(choice (const mandatory-args-only)
@@ -4755,7 +4755,7 @@ to look backward for."
    (TeX-master-directory)))
 
 (defun TeX-near-bobp ()
-  "Return t iff there's nothing but whitespace between (bob) and (point)."
+  "Return t if there's nothing but whitespace between (bob) and (point)."
   (save-excursion
     (skip-chars-backward " \t\n")
     (bobp)))
@@ -5274,7 +5274,7 @@ whitespace as well."
 
 (defun TeX-in-line-comment ()
   "Return non-nil if point is in a line comment.
-A line comment is a comment starting in column one, i.e. there is
+A line comment is a comment starting in column one, that is, there is
 no whitespace before the comment sign."
   (save-excursion
     (forward-line 0)
@@ -5475,7 +5475,7 @@ do not search further than this position in the buffer."
 
 (defun TeX-find-closing-brace (&optional depth limit)
   "Return the position of the closing brace in a TeX group.
-The function assumes that point is inside the group, i.e. after
+The function assumes that point is inside the group, that is, after
 an opening brace.  With optional DEPTH>=1, find that outer level.
 If LIMIT is non-nil, do not search further down than this
 position in the buffer."
@@ -5483,7 +5483,7 @@ position in the buffer."
 
 (defun TeX-find-opening-brace (&optional depth limit)
   "Return the position of the opening brace in a TeX group.
-The function assumes that point is inside the group, i.e. before
+The function assumes that point is inside the group, that is, before
 a closing brace.  With optional DEPTH>=1, find that outer level.
 If LIMIT is non-nil, do not search further up than this position
 in the buffer."
@@ -6390,7 +6390,7 @@ The second is a list of modes the backend should be 
activated in.
 
 The third is a function returning a list of documents available
 to the backend.  It should return nil if the backend is not
-available, e.g. if a required executable is not present on the
+available, for example if a required executable is not present on the
 system in question.
 
 The fourth is a function for displaying the documentation.  The
@@ -6636,7 +6636,7 @@ error."
      (lambda () (null TeX-electric-math)))
 
 (defun TeX--list-of-string-p (lst)
-  "Return non-nil iff `LST' is a list of strings.
+  "Return non-nil if LST is a list of strings.
 Used as function for validating a variable's `safe-local-variable' property."
   (and (listp lst)
        (let ((all-strings t))
diff --git a/texmathp.el b/texmathp.el
index b0fd02d..7ede010 100644
--- a/texmathp.el
+++ b/texmathp.el
@@ -247,8 +247,8 @@ will be considered arguments of the macro independent of 
its definition."
 (defvar texmathp-why nil
   "After a call to `texmathp' this variable shows why math-mode is on or off.
 The value is a cons cell (MATCH . POSITION).
-MATCH is a string like a car of an entry in `texmathp-tex-commands', e.g.
-\"equation\" or \"\\ensuremath\" or \"\\=\\[\" or \"$\".
+MATCH is a string like a car of an entry in `texmathp-tex-commands', for
+example \"equation\" or \"\\ensuremath\" or \"\\=\\[\" or \"$\".
 POSITION is the buffer position of the match.  If there was no match,
 it points to the limit used for searches, usually two paragraphs up.")
 



reply via email to

[Prev in Thread] Current Thread [Next in Thread]