From: Roland Winkler <winkler@gnu.org>
Date: Sat, 11 Jan 2025 03:48:54 +0000 (-0600)
Subject: Improve some docstrings in bibtex.el
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=27e57c92c2c7a0f04f5630de7cca5b2e3af3a5b4;p=emacs.git

Improve some docstrings in bibtex.el

* lisp/textmodes/bibtex.el: (bibtex-BibTeX-entry-alist)
(bibtex-biblatex-entry-alist, bibtex-BibTeX-field-alist): Improve docstrings.
(bibtex-biblatex-entry-alist): Minor fix.

(cherry picked from commit f51129b4fc3f50a20856d0d9bd1ac5b61daf08da)
---

diff --git a/lisp/textmodes/bibtex.el b/lisp/textmodes/bibtex.el
index a8f803f7313..5e79ccc6e55 100644
--- a/lisp/textmodes/bibtex.el
+++ b/lisp/textmodes/bibtex.el
@@ -448,11 +448,11 @@ If parsing fails, try to set this variable to nil."
       ("howpublished" "The way in which the work was published")
       ("month") ("year") ("note"))))
   "Alist of BibTeX entry types and their associated fields.
-Elements are lists of the form (ENTRY DOC REQUIRED CROSSREF OPTIONAL)
+Elements are lists (ENTRY DOC REQUIRED CROSSREF OPTIONAL)
 or (ENTRY DOC REF-ENTRY).
 
 ENTRY is the type of a BibTeX entry.
-DOC is a brief doc string used for documentation.  If nil, ENTRY is used.
+DOC is a brief doc string used for documentation.  If nil use ENTRY.
 REF-ENTRY is another entry type, where ENTRY becomes an alias that inherits
 the definition of REF-ENTRY.
 
@@ -743,7 +743,7 @@ See also `bibtex-BibTeX-aux-entry-alist' which takes precedence."
     ("PhdThesis" "PhD Thesis"
      (("author")
       ("title" "Title of the PhD thesis")
-      ("institution")
+      ("institution" nil nil 6) ("school" nil nil -6)
       ("date" nil nil 1) ("year" nil nil -1))
      nil
      (("subtitle") ("titleaddon") ("language") ("note")
@@ -875,9 +875,9 @@ Use this, e.g., for custom fields, see Sec. 2.2.4 of the biblatex manual."
     ("crossref" "Reference key of the cross-referenced entry")
     ("key" "Used as label with certain BibTeX styles"))
     "Alist of BibTeX fields.
-Each element is a list of the form (FIELD COMMENT).  COMMENT is
-a comment used with `bibtex-print-help-message' as a default
-if `bibtex-BibTeX-entry-alist' does not define a comment for FIELD."
+Each element is a list (FIELD COMMENT).  COMMENT is a comment used with
+`bibtex-print-help-message' as a default if `bibtex-BibTeX-entry-alist'
+does not define a comment for FIELD."
   :group 'bibtex
   :version "31.1"
   :type 'bibtex-field-alist)