; lisp/transient.el: Revert some misguided stylistic fixes.

These aren't actual modes.  Set checkdoc-symbol-words to avoid
false-positives.  The first line of doc-strings of methods do
not need to end with period.
This commit is contained in:
Jonas Bernoulli 2021-10-24 15:35:05 +02:00
parent 3f763898aa
commit 3b5de7f991
No known key found for this signature in database
GPG key ID: 230C2EFBB326D927

View file

@ -1289,8 +1289,8 @@ variable instead.")
(defvar transient--exitp nil "Whether to exit the transient.") (defvar transient--exitp nil "Whether to exit the transient.")
(defvar transient--showp nil "Whether the transient is show in a popup buffer.") (defvar transient--showp nil "Whether the transient is show in a popup buffer.")
(defvar transient--helpp nil "Whether `help-mode' is active.") (defvar transient--helpp nil "Whether help-mode is active.")
(defvar transient--editp nil "Whether `edit-mode' is active.") (defvar transient--editp nil "Whether edit-mode is active.")
(defvar transient--active-infix nil "The active infix awaiting user input.") (defvar transient--active-infix nil "The active infix awaiting user input.")
@ -3119,19 +3119,19 @@ and its value is returned to the caller."
desc))) desc)))
(cl-defmethod transient-format-description ((obj transient-group)) (cl-defmethod transient-format-description ((obj transient-group))
"Format the description by calling the next method. "Format the description by calling the next method. If the result
If the result doesn't use the `face' property at all, then apply doesn't use the `face' property at all, then apply the face
the face `transient-heading' to the complete string." `transient-heading' to the complete string."
(when-let ((desc (cl-call-next-method obj))) (when-let ((desc (cl-call-next-method obj)))
(if (text-property-not-all 0 (length desc) 'face nil desc) (if (text-property-not-all 0 (length desc) 'face nil desc)
desc desc
(propertize desc 'face 'transient-heading)))) (propertize desc 'face 'transient-heading))))
(cl-defmethod transient-format-description :around ((obj transient-suffix)) (cl-defmethod transient-format-description :around ((obj transient-suffix))
"Format the description by calling the next method. "Format the description by calling the next method. If the result
If the result is nil, then use \"(BUG: no description)\" as the is nil, then use \"(BUG: no description)\" as the description.
description. If the OBJ's `key' is currently unreachable, then If the OBJ's `key' is currently unreachable, then apply the face
apply the face `transient-unreachable' to the complete string." `transient-unreachable' to the complete string."
(let ((desc (or (cl-call-next-method obj) (let ((desc (or (cl-call-next-method obj)
(and (slot-boundp transient--prefix 'suffix-description) (and (slot-boundp transient--prefix 'suffix-description)
(funcall (oref transient--prefix suffix-description) (funcall (oref transient--prefix suffix-description)
@ -3672,5 +3672,6 @@ we stop there."
(provide 'transient) (provide 'transient)
;; Local Variables: ;; Local Variables:
;; indent-tabs-mode: nil ;; indent-tabs-mode: nil
;; checkdoc-symbol-words: ("command-line" "edit-mode" "help-mode")
;; End: ;; End:
;;; transient.el ends here ;;; transient.el ends here