procyberian/emacs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update cl-defgeneric and cl-defmethod docstrings

Browse source 
* lisp/emacs-lisp/cl-generic.el: Remove outdated TODO item.
(cl-defgeneric): Rename BODY to DEFAULT-BODY.
(cl-defmethod): Mention that multiple dispatch arguments are
allowed.  Document supported types.  (Bug#22336)
This commit is contained in:
Dmitry Gutov 2016-01-24 03:35:39 +03:00
parent 2111e0eeb5
commit 62f4ed477e
1 changed files with 14 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
lisp/emacs-lisp/cl-generic.el
View file

@ -83,8 +83,6 @@
;; - A generic "filter" generalizer (e.g. could be used to cleanly add methods ;; - A generic "filter" generalizer (e.g. could be used to cleanly add methods
;; to cl-generic-combine-methods with a specializer that says it applies only ;; to cl-generic-combine-methods with a specializer that says it applies only
;; when some particular qualifier is used). ;; when some particular qualifier is used).
;; - A way to dispatch on the context (e.g. the major-mode, some global
;; variable, you name it).
;;; Code: ;;; Code:
@ -195,9 +193,9 @@ OPTIONS-AND-METHODS currently understands:
- (declare DECLARATIONS) - (declare DECLARATIONS)
- (:argument-precedence-order &rest ARGS) - (:argument-precedence-order &rest ARGS)
- (:method [QUALIFIERS...] ARGS &rest BODY) - (:method [QUALIFIERS...] ARGS &rest BODY)
BODY, if present, is used as the body of a default method. DEFAULT-BODY, if present, is used as the body of a default method.
\(fn NAME ARGS [DOC-STRING] [OPTIONS-AND-METHODS...] &rest BODY)" \(fn NAME ARGS [DOC-STRING] [OPTIONS-AND-METHODS...] &rest DEFAULT-BODY)"
(declare (indent 2) (doc-string 3)) (declare (indent 2) (doc-string 3))
(let* ((doc (if (stringp (car-safe options-and-methods)) (let* ((doc (if (stringp (car-safe options-and-methods))
(pop options-and-methods))) (pop options-and-methods)))
@ -360,10 +358,10 @@ the specializer used will be the one returned by BODY."
(defmacro cl-defmethod (name args &rest body) (defmacro cl-defmethod (name args &rest body)
"Define a new method for generic function NAME. "Define a new method for generic function NAME.
I.e. it defines the implementation of NAME to use for invocations where the I.e. it defines the implementation of NAME to use for invocations where the
value of the dispatch argument matches the specified TYPE. values of the dispatch arguments match the specified TYPEs.
The dispatch argument has to be one of the mandatory arguments, and The dispatch arguments have to be among the mandatory arguments, and
all methods of NAME have to use the same argument for dispatch. all methods of NAME have to use the same set of arguments for dispatch.
The dispatch argument and TYPE are specified in ARGS where the corresponding Each dispatch argument and TYPE are specified in ARGS where the corresponding
formal argument appears as (VAR TYPE) rather than just VAR. formal argument appears as (VAR TYPE) rather than just VAR.
The optional second argument QUALIFIER is a specifier that The optional second argument QUALIFIER is a specifier that
@ -373,8 +371,14 @@ modifies how the method is combined with other methods, including:
:around - Method will be called around everything else :around - Method will be called around everything else
The absence of QUALIFIER means this is a \"primary\" method. The absence of QUALIFIER means this is a \"primary\" method.
Other than a type, TYPE can also be of the form `(eql VAL)' in TYPE can be one of the basic types (see the full list and their
which case this method will be invoked when the argument is `eql' to VAL. hierarchy in `cl--generic-typeof-types'), CL struct type, or an
EIEIO class.
Other than that, TYPE can also be of the form `(eql VAL)' in
which case this method will be invoked when the argument is `eql'
to VAL, or `(head VAL)', in which case the argument is required
to be a cons with VAL as its head.
\(fn NAME [QUALIFIER] ARGS &rest [DOCSTRING] BODY)" \(fn NAME [QUALIFIER] ARGS &rest [DOCSTRING] BODY)"
(declare (doc-string 3) (indent 2) (declare (doc-string 3) (indent 2)