From f75f6623b3a71a593fa1fd5e9913013ecbd0806b Mon Sep 17 00:00:00 2001
From: James Shubin <james@shubin.ca>
Date: Fri, 22 Mar 2024 02:24:50 -0400
Subject: [PATCH] util: recwatch: Improve godoc

---
 util/recwatch/recwatch.go | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/util/recwatch/recwatch.go b/util/recwatch/recwatch.go
index d16f483b..f9aff50e 100644
--- a/util/recwatch/recwatch.go
+++ b/util/recwatch/recwatch.go
@@ -53,9 +53,15 @@ type Event struct {
 
 // RecWatcher is the struct for the recursive watcher. Run Init() on it.
 type RecWatcher struct {
-	Path    string   // computed path
-	Recurse bool     // should we watch recursively?
-	Opts    []Option // list of options we use
+	// Path is the computer path that we're watching.
+	Path string
+
+	// Recurse specifies if we should watch recursively.
+	// TODO: Should this get converted into an Option?
+	Recurse bool
+
+	// Opts are the list of options that we are using this with.
+	Opts []Option
 
 	options  *recwatchOptions // computed options
 	isDir    bool             // computed isDir