[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/fsm 5e69613 07/16: fsm: Fix checkdoc errors
From: |
Stefan Monnier |
Subject: |
[elpa] externals/fsm 5e69613 07/16: fsm: Fix checkdoc errors |
Date: |
Sun, 29 Nov 2020 12:00:24 -0500 (EST) |
branch: externals/fsm
commit 5e69613b60836df7d73682121dd970f9c84b3f21
Author: Thomas Fitzsimmons <fitzsim@fitzsim.org>
Commit: Thomas Fitzsimmons <fitzsim@fitzsim.org>
fsm: Fix checkdoc errors
---
fsm.el | 13 +++++++------
1 file changed, 7 insertions(+), 6 deletions(-)
diff --git a/fsm.el b/fsm.el
index b7a7693..c89322b 100644
--- a/fsm.el
+++ b/fsm.el
@@ -96,6 +96,7 @@
;; -- Port to cl-lib.
;; -- Remove unnecessary fsm-debug-output message.
;; -- Add FSM name to fsm-debug-output messages that were not including it.
+;; -- Fix checkdoc errors.
;; NOTE: This is version 0.1ttn4 of fsm.el, with the following
;; mods (an exercise in meta-meta-programming ;-) by ttn:
@@ -320,12 +321,13 @@ event handler explicitly asks to keep the timer."
))
(defun fsm-send (fsm event &optional callback)
- "Send EVENT to FSM asynchronously.
+ "Send FSM EVENT asynchronously.
If the state machine generates a response, eventually call
CALLBACK with the response as only argument."
(run-with-timer 0 nil #'fsm-send-sync fsm event callback))
(defun fsm-update (fsm new-state new-state-data timeout)
+ "Update FSM with NEW-STATE, NEW-STATE-DATA and TIMEOUT."
(let ((fsm-name (cadr fsm))
(old-state (plist-get (cddr fsm) :state)))
(plist-put (cddr fsm) :state new-state)
@@ -355,7 +357,7 @@ CALLBACK with the response as only argument."
(apply 'fsm-send-sync fsm event))))))
(defun fsm-send-sync (fsm event &optional callback)
- "Send EVENT to FSM synchronously.
+ "Send FSM EVENT synchronously.
If the state machine generates a response, eventually call
CALLBACK with the response as only argument."
(save-match-data
@@ -396,9 +398,8 @@ CALLBACK with the response as only argument."
result)))))))
(defun fsm-call (fsm event)
- "Send EVENT to FSM synchronously, and wait for a reply.
-Return the reply.
-`with-timeout' might be useful."
+ "Send FSM EVENT synchronously, and wait for a reply.
+Return the reply. `with-timeout' might be useful."
(let (reply)
(fsm-send-sync fsm event (lambda (r) (setq reply (list r))))
(while (null reply)
@@ -420,7 +421,7 @@ Events sent are of the form (:sentinel PROCESS STRING)."
(fsm-send-sync fsm (list :sentinel process string)))))
(defun fsm-sleep (fsm secs)
- "Sleep up to SECS seconds in a way that lets FSM receive events."
+ "Let FSM receive events while sleeping up to SECS seconds."
(funcall (plist-get (cddr fsm) :sleep) secs))
(defun fsm-get-state-data (fsm)
- [elpa] externals/fsm 3acbc4d 14/16: packages/fsm: Bump version to 0.2.1, (continued)
- [elpa] externals/fsm 3acbc4d 14/16: packages/fsm: Bump version to 0.2.1, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm aaea24a 01/16: fsm: Import fsm.el from emacs-jabber, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm 384864d 03/16: fsm: Fix formatting, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm e3c4c03 04/16: fsm: Use lexical binding, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm 74d3364 11/16: fsm: Bump version to 0.2, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm 3548ca5 12/16: fsm: Revert some changes suggested by checkdoc, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm 1e86cbc 09/16: fsm: Fix copyright, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm b7d74b3 16/16: * .gitignore: New file, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm 1044ede 10/16: fsm: Change FSMs from plists to uninterned symbols, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm 3b66086 13/16: packages/fsm: Fix compilation error, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm 5e69613 07/16: fsm: Fix checkdoc errors,
Stefan Monnier <=
- [elpa] externals/fsm 5ecf3cb 05/16: fsm: Port to cl-lib, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm ccc2f3f 08/16: fsm: Add packaging fields, Stefan Monnier, 2020/11/29
- [elpa] externals/fsm f4f4d3a 15/16: ; * packages/fsm/fsm.el: Comment., Stefan Monnier, 2020/11/29
- [elpa] externals/fsm 8da631d 02/16: fsm: Delete trailing whitespace, Stefan Monnier, 2020/11/29