aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJuanma Barranquero2019-12-24 02:37:08 +0100
committerJuanma Barranquero2019-12-24 02:37:08 +0100
commit75d0cef20dbc522e6217a5765f21bfa841aff89b (patch)
tree1f3e5b74b05ea2e6789c9a35ea395b0b3ab62518
parentee12c421b61218a868712f66b0176c451e20717e (diff)
downloademacs-75d0cef20dbc522e6217a5765f21bfa841aff89b.tar.gz
emacs-75d0cef20dbc522e6217a5765f21bfa841aff89b.zip
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.
-rw-r--r--ChangeLog.350
-rw-r--r--lisp/cedet/semantic/analyze.el3
-rw-r--r--lisp/emacs-lisp/cl-macs.el2
-rw-r--r--lisp/emacs-lisp/map.el11
-rw-r--r--lisp/filesets.el2
-rw-r--r--lisp/progmodes/compile.el2
-rw-r--r--lisp/progmodes/prolog.el2
-rw-r--r--lisp/progmodes/sql.el2
-rw-r--r--lisp/term.el2
-rw-r--r--src/syntax.c2
10 files changed, 41 insertions, 37 deletions
diff --git a/ChangeLog.3 b/ChangeLog.3
index 27df42cec4d..9f2f8ced227 100644
--- a/ChangeLog.3
+++ b/ChangeLog.3
@@ -3,7 +3,6 @@
3 * etc/AUTHORS: Update. 3 * etc/AUTHORS: Update.
4 4
52019-08-29 Nicolas Petton <nicolas@petton.fr> 52019-08-29 Nicolas Petton <nicolas@petton.fr>
62019-08-29 Nicolas Petton <nicolas@petton.fr>
7 6
8 * etc/NEWS: Delete temporary markup. 7 * etc/NEWS: Delete temporary markup.
9 8
@@ -64939,7 +64938,8 @@
64939 64938
64940 (eww-setup-buffer): Restore left-to-right defaults 64939 (eww-setup-buffer): Restore left-to-right defaults
64941 64940
64942 * eww.el (eww-setup-buffer): Restore left-to-right defaults. 64941 * lisp/net/eww.el (eww-setup-buffer): Restore left-to-right
64942 defaults.
64943 64943
649442015-12-27 Lars Ingebrigtsen <larsi@gnus.org> 649442015-12-27 Lars Ingebrigtsen <larsi@gnus.org>
64945 64945
@@ -64955,7 +64955,8 @@
64955 64955
649562015-12-26 Lars Ingebrigtsen <larsi@gnus.org> 649562015-12-26 Lars Ingebrigtsen <larsi@gnus.org>
64957 64957
64958 * shr.el (shr-descend): Allow using lambdas in external functions. 64958 * lisp/net/shr.el (shr-descend): Allow using lambdas in external
64959 functions.
64959 64960
649602015-12-25 Stefan Monnier <monnier@iro.umontreal.ca> 649612015-12-25 Stefan Monnier <monnier@iro.umontreal.ca>
64961 64962
@@ -65022,7 +65023,8 @@
65022 65023
650232015-12-25 Lars Ingebrigtsen <larsi@gnus.org> 650242015-12-25 Lars Ingebrigtsen <larsi@gnus.org>
65024 65025
65025 * eww.el (eww-display-html): Support <button> tags (bug#20485). 65026 * lisp/net/eww.el (eww-display-html): Support <button> tags
65027 (bug#20485).
65026 65028
650272015-12-25 Lars Ingebrigtsen <larsi@gnus.org> 650292015-12-25 Lars Ingebrigtsen <larsi@gnus.org>
65028 65030
@@ -65048,7 +65050,8 @@
65048 65050
650492015-12-25 Lars Ingebrigtsen <larsi@gnus.org> 650512015-12-25 Lars Ingebrigtsen <larsi@gnus.org>
65050 65052
65051 * eww.el (eww-mode-map): Fix command name of eww-toggle-colors. 65053 * lisp/net/eww.el (eww-mode-map): Fix command name of
65054 eww-toggle-colors.
65052 65055
650532015-12-25 Samer Masterson <samer@samertm.com> 650562015-12-25 Samer Masterson <samer@samertm.com>
65054 65057
@@ -65072,38 +65075,39 @@
65072 65075
65073 Follow meta refresh tags in eww 65076 Follow meta refresh tags in eww
65074 65077
65075 * eww.el (eww-tag-meta): Follow meta refresh tags (bug#22234). 65078 * lisp/net/eww.el (eww-tag-meta): Follow meta refresh tags
65079 (bug#22234).
65076 65080
650772015-12-24 Lars Ingebrigtsen <larsi@gnus.org> 650812015-12-24 Lars Ingebrigtsen <larsi@gnus.org>
65078 65082
65079 More eww file name coding fixes 65083 More eww file name coding fixes
65080 65084
65081 * eww.el (eww-decode-url-file-name): Use the base coding 65085 * lisp/net/eww.el (eww-decode-url-file-name): Use the base coding
65082 system to check for encodability. 65086 system to check for encodability.
65083 65087
650842015-12-24 Lars Ingebrigtsen <larsi@gnus.org> 650882015-12-24 Lars Ingebrigtsen <larsi@gnus.org>
65085 65089
65086 Always save eww history 65090 Always save eww history
65087 65091
65088 * eww.el (eww-setup-buffer): Always save history, even when 65092 * lisp/net/eww.el (eww-setup-buffer): Always save history, even
65089 called from outside the eww buffer (bug#19638). 65093 when called from outside the eww buffer (bug#19638).
65090 65094
650912015-12-24 Lars Ingebrigtsen <larsi@gnus.org> 650952015-12-24 Lars Ingebrigtsen <larsi@gnus.org>
65092 65096
65093 Default web pages to right-to-left 65097 Default web pages to right-to-left
65094 65098
65095 * eww.el (eww-mode): Most web pages are left-to-right, so make 65099 * lisp/net/eww.el (eww-mode): Most web pages are left-to-right,
65096 that the default (bug#19801). 65100 so make that the default (bug#19801).
65097 65101
65098 * shr.el (shr-tag-html): Respect "dir" attributes 65102 * lisp/net/shr.el (shr-tag-html): Respect "dir" attributes
65099 (left-to-right, right-to-left). 65103 (left-to-right, right-to-left).
65100 65104
651012015-12-24 Lars Ingebrigtsen <larsi@gnus.org> 651052015-12-24 Lars Ingebrigtsen <larsi@gnus.org>
65102 65106
65103 Make toggling checkboxes work again 65107 Make toggling checkboxes work again
65104 65108
65105 * eww.el (eww-update-field): Make toggling checkboxes work 65109 * lisp/net/eww.el (eww-update-field): Make toggling checkboxes
65106 again (bug#21881). 65110 work again (bug#21881).
65107 65111
651082015-12-24 Lars Ingebrigtsen <larsi@gnus.org> 651122015-12-24 Lars Ingebrigtsen <larsi@gnus.org>
65109 65113
@@ -65118,8 +65122,8 @@
65118 65122
65119 Fixes: 22117 65123 Fixes: 22117
65120 65124
65121 * shr.el (shr-descend): Stop rendering before we run out of 65125 * lisp/net/shr.el (shr-descend): Stop rendering before we run out
65122 specpdl room (bug#22117). 65126 of specpdl room (bug#22117).
65123 65127
651242015-12-24 Lars Ingebrigtsen <larsi@gnus.org> 651282015-12-24 Lars Ingebrigtsen <larsi@gnus.org>
65125 65129
@@ -65129,7 +65133,7 @@
65129 65133
65130 Allow several <tbody> tags in shr 65134 Allow several <tbody> tags in shr
65131 65135
65132 * shr.el (shr-table-body): New function to find the real body 65136 * lisp/net/shr.el (shr-table-body): New function to find the real body
65133 of a table. 65137 of a table.
65134 (shr-tag-table): Use it to render several <tbody> tags in a 65138 (shr-tag-table): Use it to render several <tbody> tags in a
65135 table (bug#22170). 65139 table (bug#22170).
@@ -65145,7 +65149,7 @@
65145 65149
65146 Decode hex-encoded URLs before using them as file names 65150 Decode hex-encoded URLs before using them as file names
65147 65151
65148 * eww.el (eww-decode-url-file-name): New function. 65152 * lisp/net/eww.el (eww-decode-url-file-name): New function.
65149 (eww-download-callback): Use it to decode file names before 65153 (eww-download-callback): Use it to decode file names before
65150 saving them. 65154 saving them.
65151 65155
@@ -65162,23 +65166,23 @@
65162 65166
65163 Allow overriding shr functions from eww 65167 Allow overriding shr functions from eww
65164 65168
65165 * eww.el (eww-display-html): Allow overriding elements in 65169 * lisp/net/eww.el (eww-display-html): Allow overriding elements in
65166 `shr-external-rendering-functions'. 65170 `shr-external-rendering-functions'.
65167 65171
651682015-12-24 Lars Ingebrigtsen <larsi@gnus.org> 651722015-12-24 Lars Ingebrigtsen <larsi@gnus.org>
65169 65173
65170 Ignore invalid SVG images 65174 Ignore invalid SVG images
65171 65175
65172 * shr.el (shr-tag-svg): Ignore SVG images that have no width 65176 * lisp/net/shr.el (shr-tag-svg): Ignore SVG images that have no
65173 or height, because these can't be displayed by ImageMagick, 65177 width or height, because these can't be displayed by ImageMagick,
65174 anyway. 65178 anyway.
65175 65179
651762015-12-24 Lars Ingebrigtsen <larsi@gnus.org> 651802015-12-24 Lars Ingebrigtsen <larsi@gnus.org>
65177 65181
65178 shr table rendering fix 65182 shr table rendering fix
65179 65183
65180 * shr.el (shr-tag-table): Allow rendering body-less tables 65184 * lisp/net/shr.el (shr-tag-table): Allow rendering body-less
65181 that have headers. 65185 tables that have headers.
65182 65186
651832015-12-22 Sam Steingold <sds@gnu.org> 651872015-12-22 Sam Steingold <sds@gnu.org>
65184 65188
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 @@
80 "Collection of any errors thrown during analysis.") 80 "Collection of any errors thrown during analysis.")
81 81
82(defun semantic-analyze-push-error (err) 82(defun semantic-analyze-push-error (err)
83 "Push the error in ERR-DATA onto the error stack. 83 "Push the error data in ERR onto the error stack."
84Argument ERR."
85 (push err semantic-analyze-error-stack)) 84 (push err semantic-analyze-error-stack))
86 85
87;;; Analysis Classes 86;;; 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."
2017Each definition can take the form (FUNC EXP) where 2017Each definition can take the form (FUNC EXP) where
2018FUNC is the function name, and EXP is an expression that returns the 2018FUNC is the function name, and EXP is an expression that returns the
2019function value to which it should be bound, or it can take the more common 2019function value to which it should be bound, or it can take the more common
2020form \(FUNC ARGLIST BODY...) which is a shorthand 2020form (FUNC ARGLIST BODY...) which is a shorthand
2021for (FUNC (lambda ARGLIST BODY)). 2021for (FUNC (lambda ARGLIST BODY)).
2022 2022
2023FUNC is defined only within FORM, not BODY, so you can't write 2023FUNC 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."
141 "Associate KEY with VALUE in MAP and return VALUE. 141 "Associate KEY with VALUE in MAP and return VALUE.
142If KEY is already present in MAP, replace the associated value 142If KEY is already present in MAP, replace the associated value
143with VALUE. 143with VALUE.
144When MAP is a list, test equality with TESTFN if non-nil, otherwise use `eql'. 144When MAP is a list, test equality with TESTFN if non-nil,
145otherwise use `eql'.
145 146
146MAP can be a list, hash-table or array." 147MAP can be a list, hash-table or array."
147 (declare (obsolete "use map-put! or (setf (map-elt ...) ...) instead" "27.1")) 148 (declare (obsolete "use map-put! or (setf (map-elt ...) ...) instead" "27.1"))
@@ -287,7 +288,7 @@ The default implementation delegates to `map-length'."
287 ;; so specifying `testfn' here is problematic: e.g. for hash-tables 288 ;; so specifying `testfn' here is problematic: e.g. for hash-tables
288 ;; we shouldn't use `gethash' unless `testfn' is the same as the map's own 289 ;; we shouldn't use `gethash' unless `testfn' is the same as the map's own
289 ;; test function! 290 ;; test function!
290 "Return non-nil If and only if MAP contains KEY. 291 "Return non-nil if and only if MAP contains KEY.
291TESTFN is deprecated. Its default depends on MAP. 292TESTFN is deprecated. Its default depends on MAP.
292The default implementation delegates to `map-do'." 293The default implementation delegates to `map-do'."
293 (unless testfn (setq testfn #'equal)) 294 (unless testfn (setq testfn #'equal))
@@ -325,7 +326,7 @@ The default implementation delegates to `map-apply'."
325 nil)) 326 nil))
326 327
327(cl-defgeneric map-every-p (pred map) 328(cl-defgeneric map-every-p (pred map)
328 "Return non-nil if (PRED key val) is non-nil for all elements of the map MAP. 329 "Return non-nil if (PRED key val) is non-nil for all elements of MAP.
329The default implementation delegates to `map-apply'." 330The default implementation delegates to `map-apply'."
330 ;; FIXME: Not sure if there's much benefit to defining it as defgeneric, 331 ;; FIXME: Not sure if there's much benefit to defining it as defgeneric,
331 ;; since as defined, I can't think of a map-type where we could provide an 332 ;; 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'."
475 476
476(cl-defmethod map-into (map (type (head hash-table))) 477(cl-defmethod map-into (map (type (head hash-table)))
477 "Convert MAP into a hash-table. 478 "Convert MAP into a hash-table.
478TYPE is a list where the car is `hash-table' and the cdr are the keyword-args 479TYPE is a list where the car is `hash-table' and the cdr are the
479forwarded to `make-hash-table'. 480keyword-args forwarded to `make-hash-table'.
480 481
481Example: 482Example:
482 (map-into '((1 . 3)) '(hash-table :test eql))" 483 (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
139put \"(setq filesets-menu-ensure-use-cached VALUE)\" into your startup 139put \"(setq filesets-menu-ensure-use-cached VALUE)\" into your startup
140file -- before loading filesets.el. 140file -- before loading filesets.el.
141 141
142So, when should you think about setting this value to t? If filesets.el 142So, when should you think about setting this value to t? If filesets.el
143is loaded before user customizations. Thus, if (require \\='filesets) 143is loaded before user customizations. Thus, if (require \\='filesets)
144precedes the `custom-set-variables' command or, for XEmacs, if init.el 144precedes the `custom-set-variables' command or, for XEmacs, if init.el
145is loaded before custom.el, set this variable to t.") 145is 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."
2629 "Display this many lines of leading context before the current message. 2629 "Display this many lines of leading context before the current message.
2630If nil or t, and the left fringe is displayed, don't scroll the 2630If nil or t, and the left fringe is displayed, don't scroll the
2631compilation output window; an arrow in the left fringe points to 2631compilation output window; an arrow in the left fringe points to
2632the current message. With no left fringe, If nil, the message 2632the current message. With no left fringe, if nil, the message
2633scrolls to the top of the window; there is no arrow. If t, don't 2633scrolls to the top of the window; there is no arrow. If t, don't
2634scroll the compilation output window at all; an arrow before 2634scroll the compilation output window at all; an arrow before
2635column zero points to the current message." 2635column 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)."
381 381
382(defcustom prolog-paren-indent 4 382(defcustom prolog-paren-indent 4
383 "The indentation increase for parenthesis expressions. 383 "The indentation increase for parenthesis expressions.
384Only used in ( If -> Then ; Else) and ( Disj1 ; Disj2 ) style expressions." 384Only used in ( If -> Then ; Else ) and ( Disj1 ; Disj2 ) style expressions."
385 :version "24.1" 385 :version "24.1"
386 :group 'prolog-indentation 386 :group 'prolog-indentation
387 :type 'integer 387 :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:
860 (wallet-func WALLET PRODUCT USER SERVER DATABASE PORT) 860 (wallet-func WALLET PRODUCT USER SERVER DATABASE PORT)
861 861
862It is expected to return either a string containing the password, 862It is expected to return either a string containing the password,
863a function returning the password, or nil, If you want to support 863a function returning the password, or nil. If you want to support
864another format of password file, then implement a different 864another format of password file, then implement a different
865search wallet function and identify the location of the password 865search wallet function and identify the location of the password
866store with `sql-password-wallet'.") 866store 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 @@
87;; for maintenance reasons, you have to edit files 'as root': before 87;; for maintenance reasons, you have to edit files 'as root': before
88;; patching term.el, I su-ed in a term.el buffer and used vi :), now I 88;; patching term.el, I su-ed in a term.el buffer and used vi :), now I
89;; simply do a C-x C-f and, via ange-ftp, the file is automatically loaded 89;; simply do a C-x C-f and, via ange-ftp, the file is automatically loaded
90;; 'as-root'. ( If you don't want to enter the root password every time you 90;; 'as-root'. (If you don't want to enter the root password every time you
91;; can put it in your .netrc: note that this is -not- advisable if you're 91;; can put it in your .netrc: note that this is -not- advisable if you're
92;; connected to the internet or if somebody else works on your workstation!) 92;; connected to the internet or if somebody else works on your workstation!)
93;; 93;;
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)
2280 for nested comments and should be zero or negative else. 2280 for nested comments and should be zero or negative else.
2281 ST_COMMENT_STYLE cannot be nested. 2281 ST_COMMENT_STYLE cannot be nested.
2282 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character 2282 PREV_SYNTAX is the SYNTAX_WITH_FLAGS of the previous character
2283 (or 0 If the search cannot start in the middle of a two-character). 2283 (or 0 if the search cannot start in the middle of a two-character).
2284 2284
2285 If successful, return true and store the charpos of the comment's 2285 If successful, return true and store the charpos of the comment's
2286 end into *CHARPOS_PTR and the corresponding bytepos into 2286 end into *CHARPOS_PTR and the corresponding bytepos into