shithub: hugo

Info  •  Files  •  Log  •  Branches

tpl: Fix golint godoc issues

--- a/tpl/fmt/fmt.go

+++ b/tpl/fmt/fmt.go

@@ -15,6 +15,7 @@

 import (

 	_fmt "fmt"

+

 	"github.com/gohugoio/hugo/helpers"

 )

@@ -44,6 +45,8 @@

 	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...)

--- a/tpl/internal/templatefuncsRegistry.go

+++ b/tpl/internal/templatefuncsRegistry.go

@@ -34,12 +34,16 @@

 	"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 @@

 	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 @@

 }

+// TemplateFuncMethodMapping represents a mapping of functions to methods for a

+// given namespace.

 type TemplateFuncMethodMapping struct {

 	Method interface{}

@@ -134,6 +142,7 @@

 	return buf.Bytes(), nil

 }

+// MarshalJSON returns the JSON encoding of namespaces.

 func (namespaces TemplateFuncsNamespaces) MarshalJSON() ([]byte, error) {

 	var buf bytes.Buffer

--- a/tpl/lang/lang.go

+++ b/tpl/lang/lang.go

@@ -36,7 +36,7 @@

 	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 @@

 	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 {

--- 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.

--- a/tpl/tplimpl/embedded/generate/generate.go

+++ b/tpl/tplimpl/embedded/generate/generate.go

@@ -81,6 +81,7 @@

 // Package embedded defines the internal templates that Hugo provides.

 package embedded

+// EmbeddedTemplates represents all embedded templates.

 var EmbeddedTemplates = [][2]string{

 `)

--- 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">