tpl: Fix golint godoc issues

diff --git a/tpl/fmt/fmt.go b/tpl/fmt/fmt.go
index 96113a5983c9572b8983bf6f74c325e1ea918942..0f4f906c28961b307d8b19ef1e2922d360fa7762 100644 (file)
--- a/tpl/fmt/fmt.go
+++ b/tpl/fmt/fmt.go
@@ -15,6 +15,7 @@ package fmt
 
 import (
        _fmt "fmt"
+
        "github.com/gohugoio/hugo/helpers"
 )
 
@@ -44,6 +45,8 @@ func (ns *Namespace) Println(a ...interface{}) string {
        return _fmt.Sprintln(a...)
 }
 
+// Errorf formats according to a format specifier and returns the string as a
+// value that satisfies error.
 func (ns *Namespace) Errorf(format string, a ...interface{}) string {
        ns.errorLogger.Printf(format, a...)
        return _fmt.Sprintf(format, a...)

diff --git a/tpl/internal/templatefuncsRegistry.go b/tpl/internal/templatefuncsRegistry.go
index 0f11be65c469b4b4237da3f05ad9f708a234e468..99877dccadeedc031cf38fd5519037103c1253cd 100644 (file)
--- a/tpl/internal/templatefuncsRegistry.go
+++ b/tpl/internal/templatefuncsRegistry.go
@@ -34,12 +34,16 @@ import (
        "github.com/gohugoio/hugo/deps"
 )
 
+// TemplateFuncsNamespaceRegistry describes a registry of functions that provide
+// namespaces.
 var TemplateFuncsNamespaceRegistry []func(d *deps.Deps) *TemplateFuncsNamespace
 
+// AddTemplateFuncsNamespace adds a given function to a registry.
 func AddTemplateFuncsNamespace(ns func(d *deps.Deps) *TemplateFuncsNamespace) {
        TemplateFuncsNamespaceRegistry = append(TemplateFuncsNamespaceRegistry, ns)
 }
 
+// TemplateFuncsNamespace represents a template function namespace.
 type TemplateFuncsNamespace struct {
        // The namespace name, "strings", "lang", etc.
        Name string
@@ -51,8 +55,10 @@ type TemplateFuncsNamespace struct {
        MethodMappings map[string]TemplateFuncMethodMapping
 }
 
+// TemplateFuncsNamespaces is a slice of TemplateFuncsNamespace.
 type TemplateFuncsNamespaces []*TemplateFuncsNamespace
 
+// AddMethodMapping adds a method to a template function namespace.
 func (t *TemplateFuncsNamespace) AddMethodMapping(m interface{}, aliases []string, examples [][2]string) {
        if t.MethodMappings == nil {
                t.MethodMappings = make(map[string]TemplateFuncMethodMapping)
@@ -80,6 +86,8 @@ func (t *TemplateFuncsNamespace) AddMethodMapping(m interface{}, aliases []strin
 
 }
 
+// TemplateFuncMethodMapping represents a mapping of functions to methods for a
+// given namespace.
 type TemplateFuncMethodMapping struct {
        Method interface{}
 
@@ -134,6 +142,7 @@ func (t goDocFunc) toJSON() ([]byte, error) {
        return buf.Bytes(), nil
 }
 
+// MarshalJSON returns the JSON encoding of namespaces.
 func (namespaces TemplateFuncsNamespaces) MarshalJSON() ([]byte, error) {
        var buf bytes.Buffer
 

diff --git a/tpl/lang/lang.go b/tpl/lang/lang.go
index b29b182ab41b415f69da552ab158b7796e7866f1..430b5e442d59eb377ff3d4423f46cf536a9d8d4e 100644 (file)
--- a/tpl/lang/lang.go
+++ b/tpl/lang/lang.go
@@ -36,7 +36,7 @@ type Namespace struct {
        deps *deps.Deps
 }
 
-// Translate ...
+// Translate returns a translated string for id.
 func (ns *Namespace) Translate(id interface{}, args ...interface{}) (string, error) {
        sid, err := cast.ToStringE(id)
        if err != nil {
@@ -140,6 +140,7 @@ type pagesLanguageMerger interface {
        MergeByLanguageInterface(other interface{}) (interface{}, error)
 }
 
+// Merge creates a union of pages from two languages.
 func (ns *Namespace) Merge(p2, p1 interface{}) (interface{}, error) {
        merger, ok := p1.(pagesLanguageMerger)
        if !ok {

diff --git a/tpl/tplimpl/embedded/README.md b/tpl/tplimpl/embedded/README.md
index e14ef111536fb3feceb94a3c06bd713ca871535f..1c01961e1733b4e1f4d4c02be074b4e1d1315081 100644 (file)
--- a/tpl/tplimpl/embedded/README.md
+++ b/tpl/tplimpl/embedded/README.md
@@ -2,4 +2,4 @@
 
 ## Build Templates
 
-If you add or modify any template in the tmplates folder, you also need to run `mage generate` to get the Go code in synch.
\ No newline at end of file
+If you add or modify any template in the templates folder, you also need to run `mage generate` to get the Go code in synch.

diff --git a/tpl/tplimpl/embedded/generate/generate.go b/tpl/tplimpl/embedded/generate/generate.go
index 14b877c550534f9f3252867db90dac03c5e18ef1..76a167a99a7049f0574545fc80410ab26ac52cdc 100644 (file)
--- a/tpl/tplimpl/embedded/generate/generate.go
+++ b/tpl/tplimpl/embedded/generate/generate.go
@@ -81,6 +81,7 @@ func main() {
 // Package embedded defines the internal templates that Hugo provides.
 package embedded
 
+// EmbeddedTemplates represents all embedded templates.
 var EmbeddedTemplates = [][2]string{
 `)
 

diff --git a/tpl/tplimpl/embedded/templates.autogen.go b/tpl/tplimpl/embedded/templates.autogen.go
index 046882ed3bee5e1fbeeadb6332da05c835c24c98..b185ec1bbd84709a13f9846ea5c306ebf0a9ddc9 100644 (file)
--- a/tpl/tplimpl/embedded/templates.autogen.go
+++ b/tpl/tplimpl/embedded/templates.autogen.go
@@ -16,6 +16,7 @@
 // Package embedded defines the internal templates that Hugo provides.
 package embedded
 
+// EmbeddedTemplates represents all embedded templates.
 var EmbeddedTemplates = [][2]string{
        {`_default/robots.txt`, `User-agent: *`},
        {`_default/rss.xml`, `<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">