From: Juanma Barranquero <lekktu@gmail.com>
Date: Tue, 24 Dec 2019 01:37:08 +0000 (+0100)
Subject: Trivial docstring fixes
X-Git-Tag: emacs-27.0.90~297
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=75d0cef20dbc522e6217a5765f21bfa841aff89b;p=emacs.git

Trivial docstring fixes

* ChangeLog.3:
* lisp/emacs-lisp/cl-macs.el (cl-flet):
* lisp/filesets.el (filesets-menu-ensure-use-cached):
* lisp/progmodes/compile.el (compilation-context-lines):
* lisp/progmodes/prolog.el (prolog-paren-indent):
* lisp/progmodes/sql.el (sql-password-search-wallet-function):
Fix typos in docstrings.

* lisp/cedet/semantic/analyze.el (semantic-analyze-push-error):
Doc fix.

* lisp/emacs-lisp/map.el (map-put, map-info): Refill docstring.
(map-contains-key): Fix typo.
(map-every-p): Doc fix.
---

diff --git a/ChangeLog.3 b/ChangeLog.3
index 27df42cec4d..9f2f8ced227 100644
--- a/ChangeLog.3
+++ b/ChangeLog.3
@@ -2,7 +2,6 @@
 
 	* etc/AUTHORS: Update.
 
-2019-08-29  Nicolas Petton  <nicolas@petton.fr>
 2019-08-29  Nicolas Petton  <nicolas@petton.fr>
 
 	* etc/NEWS: Delete temporary markup.
@@ -64939,7 +64938,8 @@
 
 	(eww-setup-buffer): Restore left-to-right defaults
 
-	* eww.el (eww-setup-buffer): Restore left-to-right defaults.
+	* lisp/net/eww.el (eww-setup-buffer): Restore left-to-right
+	defaults.
 
 2015-12-27  Lars Ingebrigtsen  <larsi@gnus.org>
 
@@ -64955,7 +64955,8 @@
 
 2015-12-26  Lars Ingebrigtsen  <larsi@gnus.org>
 
-	* shr.el (shr-descend): Allow using lambdas in external functions.
+	* lisp/net/shr.el (shr-descend): Allow using lambdas in external
+	functions.
 
 2015-12-25  Stefan Monnier  <monnier@iro.umontreal.ca>
 
@@ -65022,7 +65023,8 @@
 
 2015-12-25  Lars Ingebrigtsen  <larsi@gnus.org>
 
-	* eww.el (eww-display-html): Support <button> tags (bug#20485).
+	* lisp/net/eww.el (eww-display-html): Support <button> tags
+	(bug#20485).
 
 2015-12-25  Lars Ingebrigtsen  <larsi@gnus.org>
 
@@ -65048,7 +65050,8 @@
 
 2015-12-25  Lars Ingebrigtsen  <larsi@gnus.org>
 
-	* eww.el (eww-mode-map): Fix command name of eww-toggle-colors.
+	* lisp/net/eww.el (eww-mode-map): Fix command name of
+	eww-toggle-colors.
 
 2015-12-25  Samer Masterson  <samer@samertm.com>
 
@@ -65072,38 +65075,39 @@
 
 	Follow meta refresh tags in eww
 
-	* eww.el (eww-tag-meta): Follow meta refresh tags (bug#22234).
+	* lisp/net/eww.el (eww-tag-meta): Follow meta refresh tags
+	(bug#22234).
 
 2015-12-24  Lars Ingebrigtsen  <larsi@gnus.org>
 
 	More eww file name coding fixes
 
-	* eww.el (eww-decode-url-file-name): Use the base coding
+	* lisp/net/eww.el (eww-decode-url-file-name): Use the base coding
 	system to check for encodability.
 
 2015-12-24  Lars Ingebrigtsen  <larsi@gnus.org>
 
 	Always save eww history
 
-	* eww.el (eww-setup-buffer): Always save history, even when
-	called from outside the eww buffer (bug#19638).
+	* lisp/net/eww.el (eww-setup-buffer): Always save history, even
+	when called from outside the eww buffer (bug#19638).
 
 2015-12-24  Lars Ingebrigtsen  <larsi@gnus.org>
 
 	Default web pages to right-to-left
 
-	* eww.el (eww-mode): Most web pages are left-to-right, so make
-	that the default (bug#19801).
+	* lisp/net/eww.el (eww-mode): Most web pages are left-to-right,
+	so make that the default (bug#19801).
 
-	* shr.el (shr-tag-html): Respect "dir" attributes
+	* lisp/net/shr.el (shr-tag-html): Respect "dir" attributes
 	(left-to-right, right-to-left).
 
 2015-12-24  Lars Ingebrigtsen  <larsi@gnus.org>
 
 	Make toggling checkboxes work again
 
-	* eww.el (eww-update-field): Make toggling checkboxes work
-	again (bug#21881).
+	* lisp/net/eww.el (eww-update-field): Make toggling checkboxes
+	work again (bug#21881).
 
 2015-12-24  Lars Ingebrigtsen  <larsi@gnus.org>
 
@@ -65118,8 +65122,8 @@
 
 	Fixes: 22117
 
-	* shr.el (shr-descend): Stop rendering before we run out of
-	specpdl room (bug#22117).
+	* lisp/net/shr.el (shr-descend): Stop rendering before we run out
+	of specpdl room (bug#22117).
 
 2015-12-24  Lars Ingebrigtsen  <larsi@gnus.org>
 
@@ -65129,7 +65133,7 @@
 
 	Allow several <tbody> tags in shr
 
-	* shr.el (shr-table-body): New function to find the real body
+	* lisp/net/shr.el (shr-table-body): New function to find the real body
 	of a table.
 	(shr-tag-table): Use it to render several <tbody> tags in a
 	table (bug#22170).
@@ -65145,7 +65149,7 @@
 
 	Decode hex-encoded URLs before using them as file names
 
-	* eww.el (eww-decode-url-file-name): New function.
+	* lisp/net/eww.el (eww-decode-url-file-name): New function.
 	(eww-download-callback): Use it to decode file names before
 	saving them.
 
@@ -65162,23 +65166,23 @@
 
 	Allow overriding shr functions from eww
 
-	* eww.el (eww-display-html): Allow overriding elements in
+	* lisp/net/eww.el (eww-display-html): Allow overriding elements in
 	`shr-external-rendering-functions'.
 
 2015-12-24  Lars Ingebrigtsen  <larsi@gnus.org>
 
 	Ignore invalid SVG images
 
-	* shr.el (shr-tag-svg): Ignore SVG images that have no width
-	or height, because these can't be displayed by ImageMagick,
+	* lisp/net/shr.el (shr-tag-svg): Ignore SVG images that have no
+	width or height, because these can't be displayed by ImageMagick,
 	anyway.
 
 2015-12-24  Lars Ingebrigtsen  <larsi@gnus.org>
 
 	shr table rendering fix
 
-	* shr.el (shr-tag-table): Allow rendering body-less tables
-	that have headers.
+	* lisp/net/shr.el (shr-tag-table): Allow rendering body-less
+	tables that have headers.
 
 2015-12-22  Sam Steingold  <sds@gnu.org>
 
diff --git a/lisp/cedet/semantic/analyze.el b/lisp/cedet/semantic/analyze.el
index d3cbe610a79..926d7f24b43 100644
--- a/lisp/cedet/semantic/analyze.el
+++ b/lisp/cedet/semantic/analyze.el
@@ -80,8 +80,7 @@
   "Collection of any errors thrown during analysis.")
 
 (defun semantic-analyze-push-error (err)
-  "Push the error in ERR-DATA onto the error stack.
-Argument ERR."
+  "Push the error data in ERR onto the error stack."
   (push err semantic-analyze-error-stack))
 
 ;;; Analysis Classes
diff --git a/lisp/emacs-lisp/cl-macs.el b/lisp/emacs-lisp/cl-macs.el
index a5ecf33203c..a7a1d91f3f1 100644
--- a/lisp/emacs-lisp/cl-macs.el
+++ b/lisp/emacs-lisp/cl-macs.el
@@ -2017,7 +2017,7 @@ a `let' form, except that the list of symbols can be computed at run-time."
 Each definition can take the form (FUNC EXP) where
 FUNC is the function name, and EXP is an expression that returns the
 function value to which it should be bound, or it can take the more common
-form \(FUNC ARGLIST BODY...) which is a shorthand
+form (FUNC ARGLIST BODY...) which is a shorthand
 for (FUNC (lambda ARGLIST BODY)).
 
 FUNC is defined only within FORM, not BODY, so you can't write
diff --git a/lisp/emacs-lisp/map.el b/lisp/emacs-lisp/map.el
index 74927b6224f..c1db79809d1 100644
--- a/lisp/emacs-lisp/map.el
+++ b/lisp/emacs-lisp/map.el
@@ -141,7 +141,8 @@ In the base definition, MAP can be an alist, hash-table, or array."
   "Associate KEY with VALUE in MAP and return VALUE.
 If KEY is already present in MAP, replace the associated value
 with VALUE.
-When MAP is a list, test equality with TESTFN if non-nil, otherwise use `eql'.
+When MAP is a list, test equality with TESTFN if non-nil,
+otherwise use `eql'.
 
 MAP can be a list, hash-table or array."
   (declare (obsolete "use map-put! or (setf (map-elt ...) ...) instead" "27.1"))
@@ -287,7 +288,7 @@ The default implementation delegates to `map-length'."
   ;; so specifying `testfn' here is problematic: e.g. for hash-tables
   ;; we shouldn't use `gethash' unless `testfn' is the same as the map's own
   ;; test function!
-  "Return non-nil If and only if MAP contains KEY.
+  "Return non-nil if and only if MAP contains KEY.
 TESTFN is deprecated.  Its default depends on MAP.
 The default implementation delegates to `map-do'."
   (unless testfn (setq testfn #'equal))
@@ -325,7 +326,7 @@ The default implementation delegates to `map-apply'."
     nil))
 
 (cl-defgeneric map-every-p (pred map)
-  "Return non-nil if (PRED key val) is non-nil for all elements of the map MAP.
+  "Return non-nil if (PRED key val) is non-nil for all elements of MAP.
 The default implementation delegates to `map-apply'."
   ;; FIXME: Not sure if there's much benefit to defining it as defgeneric,
   ;; since as defined, I can't think of a map-type where we could provide an
@@ -475,8 +476,8 @@ KEYWORD-ARGS are forwarded to `make-hash-table'."
 
 (cl-defmethod map-into (map (type (head hash-table)))
   "Convert MAP into a hash-table.
-TYPE is a list where the car is `hash-table' and the cdr are the keyword-args
-forwarded to `make-hash-table'.
+TYPE is a list where the car is `hash-table' and the cdr are the
+keyword-args forwarded to `make-hash-table'.
 
 Example:
     (map-into '((1 . 3)) '(hash-table :test eql))"
diff --git a/lisp/filesets.el b/lisp/filesets.el
index c05fff3fb74..5a810f14ac5 100644
--- a/lisp/filesets.el
+++ b/lisp/filesets.el
@@ -139,7 +139,7 @@ the default for XEmacs prior to 21.5.  If you want to change this value
 put \"(setq filesets-menu-ensure-use-cached VALUE)\" into your startup
 file -- before loading filesets.el.
 
-So, when should you think about setting this value to t? If filesets.el
+So, when should you think about setting this value to t?  If filesets.el
 is loaded before user customizations.  Thus, if (require \\='filesets)
 precedes the `custom-set-variables' command or, for XEmacs, if init.el
 is loaded before custom.el, set this variable to t.")
diff --git a/lisp/progmodes/compile.el b/lisp/progmodes/compile.el
index 197d52b2dea..718e6e44e04 100644
--- a/lisp/progmodes/compile.el
+++ b/lisp/progmodes/compile.el
@@ -2629,7 +2629,7 @@ region and the first line of the next region."
   "Display this many lines of leading context before the current message.
 If nil or t, and the left fringe is displayed, don't scroll the
 compilation output window; an arrow in the left fringe points to
-the current message.  With no left fringe, If nil, the message
+the current message.  With no left fringe, if nil, the message
 scrolls to the top of the window; there is no arrow.  If t, don't
 scroll the compilation output window at all; an arrow before
 column zero points to the current message."
diff --git a/lisp/progmodes/prolog.el b/lisp/progmodes/prolog.el
index 4665500349a..d79c589955c 100644
--- a/lisp/progmodes/prolog.el
+++ b/lisp/progmodes/prolog.el
@@ -381,7 +381,7 @@ terms (if this variable is nil, default)."
 
 (defcustom prolog-paren-indent 4
   "The indentation increase for parenthesis expressions.
-Only used in ( If -> Then ; Else) and ( Disj1 ; Disj2 ) style expressions."
+Only used in ( If -> Then ; Else ) and ( Disj1 ; Disj2 ) style expressions."
   :version "24.1"
   :group 'prolog-indentation
   :type 'integer
diff --git a/lisp/progmodes/sql.el b/lisp/progmodes/sql.el
index aa42873a3dd..7a51739c5f3 100644
--- a/lisp/progmodes/sql.el
+++ b/lisp/progmodes/sql.el
@@ -860,7 +860,7 @@ The specified function will be called as:
   (wallet-func WALLET PRODUCT USER SERVER DATABASE PORT)
 
 It is expected to return either a string containing the password,
-a function returning the password, or nil, If you want to support
+a function returning the password, or nil.  If you want to support
 another format of password file, then implement a different
 search wallet function and identify the location of the password
 store with `sql-password-wallet'.")
diff --git a/lisp/term.el b/lisp/term.el
index 50a0c80bcfd..29898dfce94 100644
--- a/lisp/term.el
+++ b/lisp/term.el
@@ -87,7 +87,7 @@
 ;; for maintenance reasons, you have to edit files 'as root': before
 ;; patching term.el, I su-ed in a term.el buffer and used vi :), now I
 ;; simply do a C-x C-f and, via ange-ftp, the file is automatically loaded
-;; 'as-root'.  ( If you don't want to enter the root password every time you
+;; 'as-root'.  (If you don't want to enter the root password every time you
 ;; can put it in your .netrc: note that this is -not- advisable if you're
 ;; connected to the internet or if somebody else works on your workstation!)
 ;;
diff --git a/src/syntax.c b/src/syntax.c
index edfdae22590..0f539da328a 100644
--- a/src/syntax.c
+++ b/src/syntax.c
@@ -2280,7 +2280,7 @@ in_classes (int c, Lisp_Object iso_classes)
      for nested comments and should be zero or negative else.
      ST_COMMENT_STYLE cannot be nested.
    PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
-     (or 0 If the search cannot start in the middle of a two-character).
+     (or 0 if the search cannot start in the middle of a two-character).
 
    If successful, return true and store the charpos of the comment's
    end into *CHARPOS_PTR and the corresponding bytepos into