util: recwatch: Improve godoc

This commit is contained in:
James Shubin
2024-03-22 02:24:50 -04:00
parent 43b5a0ea6a
commit f75f6623b3

View File

@@ -53,9 +53,15 @@ type Event struct {
// RecWatcher is the struct for the recursive watcher. Run Init() on it. // RecWatcher is the struct for the recursive watcher. Run Init() on it.
type RecWatcher struct { type RecWatcher struct {
Path string // computed path // Path is the computer path that we're watching.
Recurse bool // should we watch recursively? Path string
Opts []Option // list of options we use
// 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 options *recwatchOptions // computed options
isDir bool // computed isDir isDir bool // computed isDir