branch: externals/auctex
commit 8c81f42ea5fafac8db74b5ef877a5148e67831f3
Author: Ikumi Keita <ik...@ikumi.que.jp>
Commit: Ikumi Keita <ik...@ikumi.que.jp>
Fix doc strings and comment
* latex.el (LaTeX-style-list):
* preview.el.in (preview-document-pt-list):
* tex-buf.el (TeX--concat-ext, TeX-command)
(TeX-active-master-with-quotes):
* tex.el (TeX-master,TeX-auto-regexp-list,TeX-auto-x-regexp-list)
(TeX-output-dir, TeX--master-output-dir, TeX--output-dir-arg):
Fix doc strings.
Fix defcutom specs.
* tex-fold.el (TeX-fold-mode): Fix comment.
---
latex.el | 2 +-
preview.el.in | 2 ++
tex-buf.el | 11 ++++++-----
tex-fold.el | 2 +-
tex.el | 24 +++++++++++++-----------
5 files changed, 23 insertions(+), 18 deletions(-)
diff --git a/latex.el b/latex.el
index 2351ffa..cf26383 100644
--- a/latex.el
+++ b/latex.el
@@ -2338,7 +2338,7 @@ string."
("slides"))
"List of document classes offered when inserting a document environment.
-If `TeX-arg-input-file-search' is set to `t', you will get
+If `TeX-arg-input-file-search' is set to t, you will get
completion with all LaTeX classes available in your distribution
and this variable will be ignored."
:group 'LaTeX-environment
diff --git a/preview.el.in b/preview.el.in
index 197c459..cd3825e 100644
--- a/preview.el.in
+++ b/preview.el.in
@@ -1509,6 +1509,8 @@ This is for matching screen font size and previews."
:group 'preview-appearance
:type
'(repeat (choice
+ ;; FIXME: It seems that the bug mentioned below doesn't exist
+ ;; at least for emacs 27.2.
;; This is a bug: type function seems to match variables, too.
(restricted-sexp :match-alternatives (functionp)
:tag "Function" :value preview-auctex-font-size)
diff --git a/tex-buf.el b/tex-buf.el
index f282c19..ce54251 100644
--- a/tex-buf.el
+++ b/tex-buf.el
@@ -84,7 +84,7 @@ Return non-nil if document needs to be re-TeX'ed."
If NAME-OR-FILE-FN is a string, interpret it as the filename.
Otherwise, assume it is a callable function and call it with
EXTENSION as an argument and return the result without
-modification. EXTENSION is a string which should not start with
+modification. EXTENSION is a string which should not start with
'.'."
(if (stringp name-or-file-fn)
(if extension
@@ -489,7 +489,7 @@ Do you want to select one of these engines? "
FILE-FN is the symbol of a function returning a file name. The
function has one optional argument, the extension to use on the
-file. Valid choices are `TeX-master-file' and `TeX-region-file'
+file. Valid choices are `TeX-master-file' and `TeX-region-file'.
Use the information in `TeX-command-list' to determine how to run
the command.
@@ -602,9 +602,10 @@ the following three conditions are met:
2. \" \\input\" is supplemented
3. EXTRA is non-nil (default when expanding \"%T\")
Adjust dynamically bound variable `TeX-expand-pos' to avoid possible
-infinite loop in `TeX-command-expand'. If PREPROCESS-FN is non-nil then
-it is called with the filename as an argument and the results is
-enclosed instead of the filename.
+infinite loop in `TeX-command-expand'.
+If PREPROCESS-FN is non-nil then it is called with the filename
+as an argument and the result is enclosed instead of the
+filename.
Helper function of `TeX-command-expand'. Use only within entries in
`TeX-expand-list-builtin' and `TeX-expand-list'."
diff --git a/tex-fold.el b/tex-fold.el
index 7698721..dbb4086 100644
--- a/tex-fold.el
+++ b/tex-fold.el
@@ -908,7 +908,7 @@ With zero or negative ARG turn mode off."
:keymap (list (cons TeX-fold-command-prefix TeX-fold-keymap))
(if TeX-fold-mode
(progn
- ;; The value t cause problem when body text is hidden in
+ ;; The value t causes problem when body text is hidden in
;; outline-minor-mode. (bug#36651)
;; In addition, it's better not to override user preference
;; without good reason.
diff --git a/tex.el b/tex.el
index 944fc84..d07b479 100644
--- a/tex.el
+++ b/tex.el
@@ -2282,8 +2282,8 @@ change the file.
If the variable is 'dwim, AUCTeX will try to avoid querying by
attempting to `do what I mean'; and then change the file.
-It is suggested that you use the File Variables (see the info node in
-the Emacs manual) to set this variable permanently for each file."
+It is suggested that you use the File Variables (see the info node
+`File Variables') to set this variable permanently for each file."
:group 'TeX-command
:group 'TeX-parse
:type '(choice (const :tag "Query" nil)
@@ -2525,9 +2525,9 @@ be relative to that."
"The path of the directory where output files should be placed.
A relative path is interpreted as being relative to the master
-file in `TeX-master'. The path cannot contain a directory that
-starts with '.'. If this variable is nil, the output directory is
-assumed to be the same as the directory of `TeX-master'."
+file in `TeX-master'. The path cannot contain a directory that
+starts with '.'. If this variable is nil, the output directory
+is assumed to be the same as the directory of `TeX-master'."
:group 'TeX-file
:safe #'string-or-null-p
:type '(choice (const :tag "Directory of master file" nil)
@@ -2539,8 +2539,8 @@ assumed to be the same as the directory of `TeX-master'."
If `TeX-output-dir' is nil, then return nil.
MASTER-DIR is the directory path where the master file is
-located. If RELATIVE-TO-MASTER is non-nil, make the returned path
-relative to the directory in MASTER-DIR."
+located. If RELATIVE-TO-MASTER is non-nil, make the returned
+path relative to the directory in MASTER-DIR."
(when TeX-output-dir
(let* ((master-dir (expand-file-name (or master-dir "")))
(out-dir (file-name-as-directory
@@ -2558,7 +2558,7 @@ relative to the directory in MASTER-DIR."
(defun TeX--output-dir-arg (argname)
"Format the output directory as a command argument.
-ARGNAME is prepended to the quoted output directory. If
+ARGNAME is prepended to the quoted output directory. If
`TeX-output-dir' is nil then return an empty string."
(let ((out-dir (TeX--master-output-dir (TeX-master-directory) t)))
(if out-dir
@@ -4157,14 +4157,15 @@ If SKIP is not-nil, don't insert code for SKIP."
"List of symbols to ignore when scanning a TeX style file.")
(defcustom TeX-auto-regexp-list 'TeX-auto-full-regexp-list
- "List of regular expressions used for parsing the current file."
+ "List of regular expressions used for parsing the current file.
+It can also be a name of a variable having such value."
:type '(radio (variable-item TeX-auto-empty-regexp-list)
(variable-item TeX-auto-full-regexp-list)
(variable-item plain-TeX-auto-regexp-list)
(variable-item LaTeX-auto-minimal-regexp-list)
(variable-item LaTeX-auto-label-regexp-list)
(variable-item LaTeX-auto-regexp-list)
- (symbol :tag "Other")
+ (variable :tag "Other")
(repeat :tag "Specify"
(group (regexp :tag "Match")
(sexp :tag "Groups")
@@ -4235,6 +4236,7 @@ Use `TeX-auto-x-regexp-list' for parsing the region
between
(defcustom TeX-auto-x-regexp-list 'LaTeX-auto-label-regexp-list
"List of regular expressions used for additional parsing.
+It can also be a name of a variable having such value.
See `TeX-auto-x-parse-length'."
:type '(radio (variable-item TeX-auto-empty-regexp-list)
(variable-item TeX-auto-full-regexp-list)
@@ -4242,7 +4244,7 @@ See `TeX-auto-x-parse-length'."
(variable-item LaTeX-auto-minimal-regexp-list)
(variable-item LaTeX-auto-label-regexp-list)
(variable-item LaTeX-auto-regexp-list)
- (symbol :tag "Other")
+ (variable :tag "Other")
(repeat :tag "Specify"
(group (regexp :tag "Match")
(sexp :tag "Groups")
