aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorArun Isaac2022-06-14 00:02:29 +0530
committerArun Isaac2022-06-14 00:08:13 +0530
commitb65cdd136020af43f3915f5c572c1244965fd721 (patch)
treecf7a4b84b9882ba0857b7c493e360c3de35d9cf7
parentd279dcd6d3cf0e08c99a9a0e2ba3dd70b252b0bf (diff)
downloadthogai-b65cdd136020af43f3915f5c572c1244965fd721.tar.gz
thogai-b65cdd136020af43f3915f5c572c1244965fd721.tar.lz
thogai-b65cdd136020af43f3915f5c572c1244965fd721.zip
Rename thogai-connect to thogai-gemini-connect.
This opens up the command namespace to support other protocols in the future. * thogai.el (thogai-connect): Rename to thogai-gemini-connect. Mention the Gemini protocol in the docstring. (Commentary): Update invocation of thogai-connect. * README.org (Usage): Update invocation of thogai-connect.
-rw-r--r--README.org2
-rw-r--r--thogai.el10
2 files changed, 8 insertions, 4 deletions
diff --git a/README.org b/README.org
index 1235748..4d5c6db 100644
--- a/README.org
+++ b/README.org
@@ -9,6 +9,6 @@ as a replacement for Plover that integrates well with Emacs.
Connect to your steno machine using the Gemini protocol with
-M-x thogai-connect
+M-x thogai-gemini-connect
Chord away!
diff --git a/thogai.el b/thogai.el
index 241beaf..9dc5d25 100644
--- a/thogai.el
+++ b/thogai.el
@@ -34,7 +34,7 @@
;;
;; Connect to your steno machine using the Gemini protocol with
;;
-;; M-x thogai-connect
+;; M-x thogai-gemini-connect
;;
;; Chord away!
@@ -471,8 +471,12 @@ BYTES is a list of 6 bytes in the Gemini protocol."
(thogai-process-stroke thogai-stroke-ring))
(setq bytes nil))))))
-(defun thogai-connect (port speed)
- "Connect to steno machine at serial PORT with SPEED."
+(defun thogai-gemini-connect (port speed)
+ "Connect to steno machine via the Gemini protocol.
+
+PORT is the path or name of the serial port. SPEED is the speed
+of the port in bits per second, and is often known as the baud
+rate."
(interactive (list (serial-read-name)
(serial-read-speed)))
(make-serial-process :port port