From a64f94605512c320488c71d5b6411a7e22a0e52e Mon Sep 17 00:00:00 2001 From: sammyette Date: Sat, 7 Jan 2023 14:25:57 -0400 Subject: [PATCH] docs: add descriptions for types --- docs/api/hilbish/hilbish.jobs.md | 2 +- docs/api/hilbish/hilbish.timers.md | 2 +- job.go | 2 +- timer.go | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/api/hilbish/hilbish.jobs.md b/docs/api/hilbish/hilbish.jobs.md index a8f48aa..7ac6257 100644 --- a/docs/api/hilbish/hilbish.jobs.md +++ b/docs/api/hilbish/hilbish.jobs.md @@ -35,7 +35,7 @@ Returns the last added job from the table. ## Types ## Job -Job Type. +The Job type describes a Hilbish job. ### Properties - `cmd`: The user entered command string for the job. - `running`: Whether the job is running or not. diff --git a/docs/api/hilbish/hilbish.timers.md b/docs/api/hilbish/hilbish.timers.md index b847041..9d08ccc 100644 --- a/docs/api/hilbish/hilbish.timers.md +++ b/docs/api/hilbish/hilbish.timers.md @@ -44,7 +44,7 @@ Retrieves a timer via its ID. ## Types ## Timer -Timer type. +The Job type describes a Hilbish timer. ### Properties - `type`: What type of timer it is - `running`: If the timer is running diff --git a/job.go b/job.go index d1094c8..bdff770 100644 --- a/job.go +++ b/job.go @@ -26,7 +26,7 @@ var jobMetaKey = rt.StringValue("hshjob") // #property exitCode The last exit code of the job. // #property stdout The standard output of the job. This just means the normal logs of the process. // #property stderr The standard error stream of the process. This (usually) includes error messages of the job. -// Job Type. +// The Job type describes a Hilbish job. type job struct { cmd string running bool diff --git a/timer.go b/timer.go index 8a5e92f..d2568b1 100644 --- a/timer.go +++ b/timer.go @@ -19,7 +19,7 @@ const ( // #property type What type of timer it is // #property running If the timer is running // #property duration The duration in milliseconds that the timer will run -// Timer type. +// The Job type describes a Hilbish timer. type timer struct{ id int typ timerType