From 81c13171a985b89f2af6682dbd1d4b8766cb9af7 Mon Sep 17 00:00:00 2001 From: Jorin Vogel Date: Wed, 2 Aug 2017 14:25:05 +0200 Subject: Add some missing doc comments As pointed out by the linter, some exported functions and types are missing doc comments. The linter warnings have been reduced from 194 to 116. Not all missing comments have been added in this commit though. --- create/content_template_handler.go | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'create') diff --git a/create/content_template_handler.go b/create/content_template_handler.go index 0be495d15..286184c2b 100644 --- a/create/content_template_handler.go +++ b/create/content_template_handler.go @@ -49,6 +49,7 @@ type ArchetypeFileData struct { } const ( + // ArchetypeTemplateTemplate is used as inital template when adding an archetype template. ArchetypeTemplateTemplate = `--- title: "{{ replace .TranslationBaseName "-" " " | title }}" date: {{ .Date }} @@ -123,7 +124,7 @@ func executeArcheTypeAsTemplate(s *hugolib.Site, kind, targetPath, archetypeFile if !bytes.Contains(archetypeContent, []byte("date")) || !bytes.Contains(archetypeContent, []byte("title")) { // TODO(bep) remove some time in the future. - s.Log.FEEDBACK.Println(fmt.Sprintf(`WARNING: date and/or title missing from archetype file %q. + s.Log.FEEDBACK.Println(fmt.Sprintf(`WARNING: date and/or title missing from archetype file %q. From Hugo 0.24 this must be provided in the archetype file itself, if needed. Example: %s `, archetypeFilename, ArchetypeTemplateTemplate)) -- cgit v1.2.3