diff --git a/docs/embed.go b/docs/embed.go index 0e3b0cb..c760fa1 100644 --- a/docs/embed.go +++ b/docs/embed.go @@ -5,5 +5,7 @@ package docs import "embed" +// FS contains the embedded legal documents. +// //go:embed TERMS.md PRIVACY.md CONSENT.md var FS embed.FS diff --git a/internal/modules/email_sender/interface.go b/internal/modules/email_sender/interface.go index 8fa40f4..8b1416e 100644 --- a/internal/modules/email_sender/interface.go +++ b/internal/modules/email_sender/interface.go @@ -1,7 +1,9 @@ +// Package email_sender sends email messages over SMTP. package email_sender import "context" +// Message describes an email message. type Message struct { To string Subject string @@ -9,6 +11,7 @@ type Message struct { HTML string } +// IEmailSender sends email messages. type IEmailSender interface { Send(ctx context.Context, message Message) error } diff --git a/internal/modules/email_sender/sender.go b/internal/modules/email_sender/sender.go index ac6f8f9..78f512b 100644 --- a/internal/modules/email_sender/sender.go +++ b/internal/modules/email_sender/sender.go @@ -26,6 +26,7 @@ type sender struct { tlsConfig *tls.Config } +// NewSender creates an SMTP email sender. func NewSender( smtpHost string, smtpPort string, diff --git a/internal/modules/email_sender/template.go b/internal/modules/email_sender/template.go index 9f6da90..66ed9ea 100644 --- a/internal/modules/email_sender/template.go +++ b/internal/modules/email_sender/template.go @@ -2,6 +2,7 @@ package email_sender import "html" +// ButtonHTML returns an HTML button linking to link. func ButtonHTML(link, label string) string { return `