Merge pull request #68 from jhalter/update_default_config_comments

Add comment clarifying usage of NewsDateFormat config option

diff --git a/cmd/mobius-hotline-server/mobius/config/config.yaml b/cmd/mobius-hotline-server/mobius/config/config.yaml
index 87e500d4b8eab665c8d43791980ec00963ffe607..b089b88b0c815970d9afec74400be81816c8e359 100644 (file)
--- 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