From cf062e09037c7e54a821b05ef50b3e86683090f8 Mon Sep 17 00:00:00 2001
From: Luke Shumaker <lukeshu@lukeshu.com>
Date: Thu, 26 Jan 2023 13:59:35 -0700
Subject: Improve/fix documentation and comments

---
 decode_scan.go | 7 +++++--
 1 file changed, 5 insertions(+), 2 deletions(-)

(limited to 'decode_scan.go')

diff --git a/decode_scan.go b/decode_scan.go
index 5e33760..249975d 100644
--- a/decode_scan.go
+++ b/decode_scan.go
@@ -30,11 +30,14 @@ type runeTypeScanner interface {
 // runeTypeScannerImpl /////////////////////////////////////////////////////////////////////////////
 
 type runeTypeScannerImpl struct {
-	inner io.RuneScanner
+	// everything that is not "initialized by constructor" starts
+	// out as the zero value.
+
+	inner io.RuneScanner // initialized by constructor
 
 	initialized bool
 
-	parser internal.Parser
+	parser internal.Parser // initialized by constructor
 	offset int64
 
 	repeat  bool
-- 
cgit v1.2.3-2-g168b