shithub: hugo

Download patch

ref: 30a7c9ea37a0f36451946f8688a3f807618a7eff
parent: 8346848109ab57cb04de87c6d86859c6b3de8ffa
author: Cameron Moore <[email protected]>
date: Thu Nov 29 16:32:53 EST 2018

tpl: Add godoc packages comments

Also fix package name in tpl/templates.

--- a/tpl/cast/cast.go
+++ b/tpl/cast/cast.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package cast provides template functions for data type conversions.
 package cast
 
 import (
--- a/tpl/collections/collections.go
+++ b/tpl/collections/collections.go
@@ -11,6 +11,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package collections provides template functions for manipulating collections
+// such as arrays, maps, and slices.
 package collections
 
 import (
--- a/tpl/compare/compare.go
+++ b/tpl/compare/compare.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package compare provides template functions for comparing values.
 package compare
 
 import (
--- a/tpl/crypto/crypto.go
+++ b/tpl/crypto/crypto.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package crypto provides template functions for cryptographic operations.
 package crypto
 
 import (
--- a/tpl/data/data.go
+++ b/tpl/data/data.go
@@ -11,6 +11,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package data provides template functions for working with external data
+// sources.
 package data
 
 import (
--- a/tpl/encoding/encoding.go
+++ b/tpl/encoding/encoding.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package encoding provides template functions for encoding content.
 package encoding
 
 import (
--- a/tpl/fmt/fmt.go
+++ b/tpl/fmt/fmt.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package fmt provides template functions for formatting strings.
 package fmt
 
 import (
--- a/tpl/images/images.go
+++ b/tpl/images/images.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package images provides template functions for manipulating images.
 package images
 
 import (
--- a/tpl/inflect/inflect.go
+++ b/tpl/inflect/inflect.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package inflect provides template functions for the inflection of words.
 package inflect
 
 import (
--- a/tpl/lang/lang.go
+++ b/tpl/lang/lang.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package lang provides template functions for content internationalization.
 package lang
 
 import (
--- a/tpl/math/math.go
+++ b/tpl/math/math.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package math provides template functions for mathmatical operations.
 package math
 
 import (
--- a/tpl/os/os.go
+++ b/tpl/os/os.go
@@ -11,6 +11,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package os provides template functions for interacting with the operating
+// system.
 package os
 
 import (
--- a/tpl/partials/partials.go
+++ b/tpl/partials/partials.go
@@ -11,6 +11,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package partials provides template functions for working with reusable
+// templates.
 package partials
 
 import (
--- a/tpl/path/path.go
+++ b/tpl/path/path.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package path provides template functions for manipulating paths.
 package path
 
 import (
--- a/tpl/resources/resources.go
+++ b/tpl/resources/resources.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package resources provides template functions for working with resources.
 package resources
 
 import (
--- a/tpl/safe/safe.go
+++ b/tpl/safe/safe.go
@@ -11,6 +11,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package safe provides template functions for escaping untrusted content or
+// encapsulating trusted content.
 package safe
 
 import (
--- a/tpl/strings/strings.go
+++ b/tpl/strings/strings.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package strings provides template functions for manipulating strings.
 package strings
 
 import (
--- a/tpl/templates/init.go
+++ b/tpl/templates/init.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package partials
+package templates
 
 import (
 	"github.com/gohugoio/hugo/deps"
--- a/tpl/templates/init_test.go
+++ b/tpl/templates/init_test.go
@@ -11,7 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package partials
+package templates
 
 import (
 	"testing"
--- a/tpl/templates/templates.go
+++ b/tpl/templates/templates.go
@@ -11,7 +11,8 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package partials
+// Package templates provides template functions for working with templates.
+package templates
 
 import (
 	"github.com/gohugoio/hugo/deps"
--- a/tpl/time/time.go
+++ b/tpl/time/time.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package time provides template functions for measuring and displaying time.
 package time
 
 import (
--- a/tpl/transform/transform.go
+++ b/tpl/transform/transform.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package transform provides template functions for transforming content.
 package transform
 
 import (
--- a/tpl/urls/urls.go
+++ b/tpl/urls/urls.go
@@ -11,6 +11,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package urls provides template functions to deal with URLs.
 package urls
 
 import (