tpl: Add godoc packages comments

Also fix package name in tpl/templates.

diff --git a/tpl/cast/cast.go b/tpl/cast/cast.go
index 999b31214e19ed3734048b40550b4021678b597a..c864b5e323e30d99a15caebac2d070e9fe15f162 100644 (file)
--- 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 (

diff --git a/tpl/collections/collections.go b/tpl/collections/collections.go
index d9baddf6b5f39dc26c6ad476249ba0f4ab8c68de..bad65369fab4cef58582e2c7737159524860b18a 100644 (file)
--- 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 (

diff --git a/tpl/compare/compare.go b/tpl/compare/compare.go
index b228040cdc920068c8ad56eb47318ae8b213742c..08fb492d674a7647ddd067741931f9fef343cb3c 100644 (file)
--- 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 (

diff --git a/tpl/crypto/crypto.go b/tpl/crypto/crypto.go
index 7aaa9291ed25b71bb29467bc5985347c4089c4ed..5771c98b5d0fc4e97dd6094edd2e5983648a7c5e 100644 (file)
--- 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 (

diff --git a/tpl/data/data.go b/tpl/data/data.go
index 61de2f72ed2524df8ffcf06ce6c25edee19583ce..33eee7b27bf253962fbbe69ad6481cc98778d8fb 100644 (file)
--- 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 (

diff --git a/tpl/encoding/encoding.go b/tpl/encoding/encoding.go
index 4b02c426a93dd6752f68988e0c27f28732c91a01..9045acd1cfcb5a9bffa69954b0ca0098f234d0ad 100644 (file)
--- 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 (

diff --git a/tpl/fmt/fmt.go b/tpl/fmt/fmt.go
index 09e4f5a405a1cc30eb97366723f3111fc2c1b924..8b24648cbbd8f994a1ee8415b2ddfe46acb23c88 100644 (file)
--- 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 (

diff --git a/tpl/images/images.go b/tpl/images/images.go
index f5d32f4495052ae7e902a5ec89a3fd48a7d5e395..4cb809df7746211ad42d37fd1b40fd09ea1aaf1d 100644 (file)
--- 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 (

diff --git a/tpl/inflect/inflect.go b/tpl/inflect/inflect.go
index 31b22dbcc5cdc547f5ea484d4232c9c644189822..187f360d6220a87e6a5af7948aa8c566bc0e3ca3 100644 (file)
--- 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 (

diff --git a/tpl/lang/lang.go b/tpl/lang/lang.go
index 4c011b1ce9651a974358f221f51f053351c00946..9a9f467bbc399078378ea603fded2540eabde582 100644 (file)
--- 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 (

diff --git a/tpl/math/math.go b/tpl/math/math.go
index fcc6abc3d04b5dcc3a6fa479760a3db421354c07..0bc813dced59eb34d3e0edc96a33311ca3ccda67 100644 (file)
--- 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 (

diff --git a/tpl/os/os.go b/tpl/os/os.go
index aca80ae9dac29e3255b10dce18c44f10f0be288d..cc4a42d5d34ca81da003aa3f5c8ec77dbe72094a 100644 (file)
--- 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 (

diff --git a/tpl/partials/partials.go b/tpl/partials/partials.go
index dba0e50139b5ea9a188dff8f3b1048896e6cb2ee..39bb153e0d3e0d7350bb165b1828001620fdb50f 100644 (file)
--- 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 (

diff --git a/tpl/path/path.go b/tpl/path/path.go
index f975726cc3459724ae5b247eee9cd0502851a845..6410552240a60ad022b2a89ad12b3dd49d6efa52 100644 (file)
--- 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 (

diff --git a/tpl/resources/resources.go b/tpl/resources/resources.go
index 8b30f3156b5b3862bc0c1c3c19d0392f038ca63b..a20b2e503761392e1e38da348a6c3fdb5c47012b 100644 (file)
--- 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 (

diff --git a/tpl/safe/safe.go b/tpl/safe/safe.go
index 64c36cc4d92b53c91c43459afc309338aae222bf..4abd34e7fa49a8578dbc6a47a40f38c9b176d9bb 100644 (file)
--- 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 (

diff --git a/tpl/strings/strings.go b/tpl/strings/strings.go
index 1853cd727ca05e95c086b70db6f3dc2e1d404f33..91d533af9d83aa901122c2c733e25dd950d9c39e 100644 (file)
--- 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 (

diff --git a/tpl/templates/init.go b/tpl/templates/init.go
index a68809e654a6092f55db1382df4f1d390e27a0ab..8bc53ef4971299e71fbd50c833158d766a8e2962 100644 (file)
--- 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"

diff --git a/tpl/templates/init_test.go b/tpl/templates/init_test.go
index d833cddc1cdc4ea747077af66dc9b94c03e3b69d..9a0533fe8bff79ef5550cd557a9918584fa19f0d 100644 (file)
--- 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"

diff --git a/tpl/templates/templates.go b/tpl/templates/templates.go
index 7a69e28a697c835b7ffdae3a8595962952cc286b..44d397e68ce45c3673eaa35c7a11564a04ba2004 100644 (file)
--- 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"

diff --git a/tpl/time/time.go b/tpl/time/time.go
index d56c85405d15b89202f1d58f6a2c65ce6c6d967f..598124648f64307e5173566037617216770d13c4 100644 (file)
--- 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 (

diff --git a/tpl/transform/transform.go b/tpl/transform/transform.go
index 7ec1fec0205ce779365428aa83b2d3307590641a..777e31c3ecd7ac21f6dc674e9ec0faccae2ac3e5 100644 (file)
--- 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 (

diff --git a/tpl/urls/urls.go b/tpl/urls/urls.go
index 7abf45ba21844b7ba502d45e2bd8521049576f20..754114b2b7ec29371e2d79f51b889a00a38534ba 100644 (file)
--- 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 (