Improve code documentation

This commit is contained in:
TwinProduction
2020-10-23 15:58:59 -04:00
parent c09cd9df7e
commit 1bde98868e
5 changed files with 24 additions and 4 deletions

View File

@ -29,11 +29,20 @@ type Alert struct {
Triggered bool
}
// AlertType is the type of the alert.
// The value will generally be the name of the alert provider
type AlertType string
const (
SlackAlert AlertType = "slack"
// SlackAlert is the AlertType for the slack alerting provider
SlackAlert AlertType = "slack"
// PagerDutyAlert is the AlertType for the pagerduty alerting provider
PagerDutyAlert AlertType = "pagerduty"
TwilioAlert AlertType = "twilio"
CustomAlert AlertType = "custom"
// TwilioAlert is the AlertType for the twilio alerting provider
TwilioAlert AlertType = "twilio"
// CustomAlert is the AlertType for the custom alerting provider
CustomAlert AlertType = "custom"
)