From 9575ec614a5b0b0a0536e644fb426955ead01f08 Mon Sep 17 00:00:00 2001 From: siddharth Date: Mon, 13 Dec 2021 21:31:59 -0500 Subject: state/state.go: add docs --- state/state.go | 3 +++ 1 file changed, 3 insertions(+) diff --git a/state/state.go b/state/state.go index c37a74b..7c67bdb 100644 --- a/state/state.go +++ b/state/state.go @@ -19,6 +19,8 @@ type EntryResult struct { Err error // Set on error } +// Paraphernalia passed and shared between go routines that process +// the feeds. type ProcessState struct { // Tracks entries that have already been downloaded. DB *db.FernDB @@ -28,6 +30,7 @@ type ProcessState struct { FeedResultChan chan FeedResult } +// Creates an instance of ProcessState and returns a pointer to it. func NewProcessState() *ProcessState { ps := new(ProcessState) ps.FeedResultChan = make(chan FeedResult) -- cgit v1.2.3