Commit 82a63ef6 authored by Kyle Clarke's avatar Kyle Clarke

Updated doc block comments for better readability on godoc.org

parent 098c1f3d
Pipeline #4130572 passed with stage
in 32 seconds
......@@ -67,7 +67,7 @@ func All() schedules {
return pool.schedules
}
// ByName will attempt to return by name a Scheduler instance for the local schedule pool.
// ByName will attempt to return by name a Scheduler instance from the schedule pool.
func ByName(name string) (*schedule, error) {
v, ok := pool.schedules[name]
if ok {
......@@ -77,7 +77,7 @@ func ByName(name string) (*schedule, error) {
return nil, ErrScheduleNotFound
}
// DefaultSchedule will return the default Scheduler from the schedule pool.
// DefaultSchedule will return the default schedule from the schedule pool.
func DefaultSchedule() *schedule {
s, err := ByName(DefaultName)
if err != nil {
......
......@@ -191,7 +191,7 @@ func (r *runner) Info() RunnerInfo {
}
}
// IsCompleted will return true if a completed time is set.
// IsCompleted will return true if a completed time is not zero and therefore complete.
func (i RunnerInfo) IsCompleted() bool {
return !i.CompletedAt.IsZero()
}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment