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

Fix more overly long docstrings in eieio

Browse source 
* lisp/emacs-lisp/eieio.el (defclass): Fix more overly long
docstrings.  (Bug#58252)
This commit is contained in:
Stefan Kangas 2022-10-03 00:03:34 +02:00
parent 190582adf4
commit 655c92ce4a
1 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
lisp/emacs-lisp/eieio.el
View file

@ -218,10 +218,11 @@ and reference them using the function `class-option'."
(when (and eieio-backward-compatibility (eq alloc :class))
;; FIXME: How could I declare this *method* as obsolete.
(push `(cl-defmethod ,acces ((this (subclass ,name)))
,(format
"Retrieve the class slot `%S' from a class `%S'.
This method is obsolete."
sname name)
,(concat
(internal--format-docstring-line
"Retrieve the class slot `%S' from a class `%S'."
sname name)
"\nThis method is obsolete.")
(if (slot-boundp this ',sname)
(eieio-oref-default this ',sname)))
accessors)))
@ -230,16 +231,18 @@ This method is obsolete."
;; name whose purpose is to set the value of the slot.
(if writer
(push `(cl-defmethod ,writer ((this ,name) value)
,(format "Set the slot `%S' of an object of class `%S'."
sname name)
,(internal--format-docstring-line
"Set the slot `%S' of an object of class `%S'."
sname name)
(setf (slot-value this ',sname) value))
accessors))
;; If a reader is defined, then create a generic method
;; of that name whose purpose is to access this slot value.
(if reader
(push `(cl-defmethod ,reader ((this ,name))
,(format "Access the slot `%S' from object of class `%S'."
sname name)
,(internal--format-docstring-line
"Access the slot `%S' from object of class `%S'."
sname name)
(slot-value this ',sname))
accessors))
))