From af0e8409bd0eb3bbd97ce8d2a249344ac4d2894d Mon Sep 17 00:00:00 2001
From: Jeff Halter <868228+jhalter@users.noreply.github.com>
Date: Thu, 3 Nov 2022 17:06:55 -0700
Subject: Add comment clarifying usage of NewsDateFormat config option

---
 cmd/mobius-hotline-server/mobius/config/config.yaml | 8 ++++++++
 1 file changed, 8 insertions(+)

(limited to 'cmd')

diff --git a/cmd/mobius-hotline-server/mobius/config/config.yaml b/cmd/mobius-hotline-server/mobius/config/config.yaml
index 87e500d..b089b88 100644
--- a/cmd/mobius-hotline-server/mobius/config/config.yaml
+++ b/cmd/mobius-hotline-server/mobius/config/config.yaml
@@ -29,6 +29,14 @@ Trackers:
 PreserveResourceForks: false
 
 # Optional custom date format for flat news postings
+# The value must be a string using Golang's "example-based" formatting, which uses a special reference time of
+# Mon Jan 2 15:04:05 MST 2006 to determine the output format.
+#
+# Examples:
+#   "Jan 02 15:04 2006"
+#   "01/02/2006 15:04"
+#
+# More details: herehttps://yourbasic.org/golang/format-parse-string-time-date-example/
 NewsDateFormat: ""
 
 # Optional custom delimiter between flat news postings
-- 
cgit