From 42cd5a067863771a7ada5c166f34ecada1275a69 Mon Sep 17 00:00:00 2001
From: Peter McGoron <code@mcgoron.com>
Date: Sat, 7 Sep 2024 18:44:18 -0400
Subject: [PATCH] readtable: add documentation for PUSH->READ

---
 read.scm | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/read.scm b/read.scm
index 8724e3c..a138041 100644
--- a/read.scm
+++ b/read.scm
@@ -33,6 +33,12 @@
     (lambda ()
       (read-char port))))
 
+;;; READ:
+;;; 
+;;; (POS): Return (LIST FILENAME LINE-NUMBER OFFSET).
+;;; (READ): Read the next character in the stream. Returns #F on EOF.
+;;; (PUSH CHAR): Push CHAR such that it will be the next character read
+;;; when (READ) is called.
 (define port->read
   (lambda (read-function filename)
     (let ((line-number 1)