fix: doc comments

johnstcn · johnstcn · commit 91cc3b62b7d4 · 2022-04-04T11:18:15.000Z
diff --git a/coderd/crontab/crontab.go b/coderd/crontab/crontab.go
@@ -1,3 +1,5 @@
+// package crontab provides utilities for parsing and deserializing
+// cron-style expressions.
 package crontab
 
 import (
@@ -7,11 +9,13 @@ import (
 	"golang.org/x/xerrors"
 )
 
+// For the purposes of this library, we only need minute, hour, and
+//day-of-week.
 const parserFormat = cron.Minute | cron.Hour | cron.Dow
 
 var defaultParser = cron.NewParser(parserFormat)
 
-// CronSchedule represents a weekly cron schedule serializable to and from a string.
+// Parse parses a WeeklySchedule from spec.
 //
 // Example Usage:
 //  local_sched, _ := cron.Parse("59 23 *")
@@ -20,24 +24,6 @@ var defaultParser = cron.NewParser(parserFormat)
 //  us_sched, _ := cron.Parse("CRON_TZ=US/Central 30 9 1-5")
 //  fmt.Println(sched.Next(time.Now()).Format(time.RFC3339))
 //  // Output: 2022-04-04T14:30:00Z
-
-// WeeklySchedule is a thin wrapper for cron.SpecSchedule that implements Stringer.
-type WeeklySchedule struct {
-	sched *cron.SpecSchedule
-	// XXX: there isn't any nice way for robfig/cron to serialize
-	spec string
-}
-
-// String serializes the schedule to its original human-friendly format.
-func (s WeeklySchedule) String() string {
-	return s.spec
-}
-
-// Next returns the next time in the schedule relative to t.
-func (s WeeklySchedule) Next(t time.Time) time.Time {
-	return s.sched.Next(t)
-}
-
 func Parse(spec string) (*WeeklySchedule, error) {
 	specSched, err := defaultParser.Parse(spec)
 	if err != nil {
@@ -55,3 +41,21 @@ func Parse(spec string) (*WeeklySchedule, error) {
 	}
 	return cronSched, nil
 }
+
+// WeeklySchedule represents a weekly cron schedule.
+// It's essentially a thin wrapper for robfig/cron/v3 that implements Stringer.
+type WeeklySchedule struct {
+	sched *cron.SpecSchedule
+	// XXX: there isn't any nice way for robfig/cron to serialize
+	spec string
+}
+
+// String serializes the schedule to its original human-friendly format.
+func (s WeeklySchedule) String() string {
+	return s.spec
+}
+
+// Next returns the next time in the schedule relative to t.
+func (s WeeklySchedule) Next(t time.Time) time.Time {
+	return s.sched.Next(t)
+}
