diff options
author | Juanma Barranquero <lekktu@gmail.com> | 2019-12-24 02:37:08 +0100 |
---|---|---|
committer | Juanma Barranquero <lekktu@gmail.com> | 2019-12-24 02:37:08 +0100 |
commit | 75d0cef20dbc522e6217a5765f21bfa841aff89b (patch) | |
tree | 1f3e5b74b05ea2e6789c9a35ea395b0b3ab62518 /lisp | |
parent | ee12c421b61218a868712f66b0176c451e20717e (diff) | |
download | emacs-75d0cef20dbc522e6217a5765f21bfa841aff89b.tar.gz emacs-75d0cef20dbc522e6217a5765f21bfa841aff89b.tar.bz2 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.
Diffstat (limited to 'lisp')
-rw-r--r-- | lisp/cedet/semantic/analyze.el | 3 | ||||
-rw-r--r-- | lisp/emacs-lisp/cl-macs.el | 2 | ||||
-rw-r--r-- | lisp/emacs-lisp/map.el | 11 | ||||
-rw-r--r-- | lisp/filesets.el | 2 | ||||
-rw-r--r-- | lisp/progmodes/compile.el | 2 | ||||
-rw-r--r-- | lisp/progmodes/prolog.el | 2 | ||||
-rw-r--r-- | lisp/progmodes/sql.el | 2 | ||||
-rw-r--r-- | lisp/term.el | 2 |
8 files changed, 13 insertions, 13 deletions
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!) ;; |