fixup Job and Scheduler interface docs

This commit is contained in:
John Roesler
2023-12-20 15:13:38 -06:00
parent 93fecb6152
commit a51820e30f
3 changed files with 90 additions and 28 deletions
+70 -10
View File
@@ -148,7 +148,7 @@ func ExampleDurationRandomJob() {
)
}
func ExampleJob_ID() {
func ExampleJob_id() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -164,7 +164,7 @@ func ExampleJob_ID() {
fmt.Println(j.ID())
}
func ExampleJob_LastRun() {
func ExampleJob_lastRun() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -180,7 +180,26 @@ func ExampleJob_LastRun() {
fmt.Println(j.LastRun())
}
func ExampleJob_NextRun() {
func ExampleJob_name() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
j, _ := s.NewJob(
DurationJob(
time.Second,
),
NewTask(
func() {},
),
WithName("foobar"),
)
fmt.Println(j.Name())
// Output:
// foobar
}
func ExampleJob_nextRun() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -196,7 +215,7 @@ func ExampleJob_NextRun() {
fmt.Println(j.NextRun())
}
func ExampleJob_RunNow() {
func ExampleJob_runNow() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -218,6 +237,25 @@ func ExampleJob_RunNow() {
_ = j.RunNow()
}
func ExampleJob_tags() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
j, _ := s.NewJob(
DurationJob(
time.Second,
),
NewTask(
func() {},
),
WithTags("foo", "bar"),
)
fmt.Println(j.Tags())
// Output:
// [foo bar]
}
func ExampleMonthlyJob() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -270,7 +308,24 @@ func ExampleOneTimeJob() {
s.Start()
}
func ExampleScheduler_NewJob() {
func ExampleScheduler_jobs() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
_, _ = s.NewJob(
DurationJob(
10*time.Second,
),
NewTask(
func() {},
),
)
fmt.Println(len(s.Jobs()))
// Output:
// 1
}
func ExampleScheduler_newJob() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -288,7 +343,7 @@ func ExampleScheduler_NewJob() {
fmt.Println(j.ID())
}
func ExampleScheduler_RemoveByTags() {
func ExampleScheduler_removeByTags() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -322,7 +377,7 @@ func ExampleScheduler_RemoveByTags() {
// 0
}
func ExampleScheduler_RemoveJob() {
func ExampleScheduler_removeJob() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -346,7 +401,7 @@ func ExampleScheduler_RemoveJob() {
// 0
}
func ExampleScheduler_Start() {
func ExampleScheduler_start() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -363,7 +418,7 @@ func ExampleScheduler_Start() {
s.Start()
}
func ExampleScheduler_StopJobs() {
func ExampleScheduler_stopJobs() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
@@ -382,7 +437,12 @@ func ExampleScheduler_StopJobs() {
_ = s.StopJobs()
}
func ExampleScheduler_Update() {
func ExampleScheduler_shutdown() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()
}
func ExampleScheduler_update() {
s, _ := NewScheduler()
defer func() { _ = s.Shutdown() }()