diff options
author | Cameron Moore <moorereason@gmail.com> | 2018-11-29 21:32:53 -0600 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2018-11-30 08:56:30 +0100 |
commit | 30a7c9ea37a0f36451946f8688a3f807618a7eff (patch) | |
tree | c9e755a48d2e1daf0b3b2a41b9abece71436c32e | |
parent | 8346848109ab57cb04de87c6d86859c6b3de8ffa (diff) |
tpl: Add godoc packages comments
Also fix package name in tpl/templates.
-rw-r--r-- | tpl/cast/cast.go | 1 | ||||
-rw-r--r-- | tpl/collections/collections.go | 2 | ||||
-rw-r--r-- | tpl/compare/compare.go | 1 | ||||
-rw-r--r-- | tpl/crypto/crypto.go | 1 | ||||
-rw-r--r-- | tpl/data/data.go | 2 | ||||
-rw-r--r-- | tpl/encoding/encoding.go | 1 | ||||
-rw-r--r-- | tpl/fmt/fmt.go | 1 | ||||
-rw-r--r-- | tpl/images/images.go | 1 | ||||
-rw-r--r-- | tpl/inflect/inflect.go | 1 | ||||
-rw-r--r-- | tpl/lang/lang.go | 1 | ||||
-rw-r--r-- | tpl/math/math.go | 1 | ||||
-rw-r--r-- | tpl/os/os.go | 2 | ||||
-rw-r--r-- | tpl/partials/partials.go | 2 | ||||
-rw-r--r-- | tpl/path/path.go | 1 | ||||
-rw-r--r-- | tpl/resources/resources.go | 1 | ||||
-rw-r--r-- | tpl/safe/safe.go | 2 | ||||
-rw-r--r-- | tpl/strings/strings.go | 1 | ||||
-rw-r--r-- | tpl/templates/init.go | 2 | ||||
-rw-r--r-- | tpl/templates/init_test.go | 2 | ||||
-rw-r--r-- | tpl/templates/templates.go | 3 | ||||
-rw-r--r-- | tpl/time/time.go | 1 | ||||
-rw-r--r-- | tpl/transform/transform.go | 1 | ||||
-rw-r--r-- | tpl/urls/urls.go | 1 |
23 files changed, 29 insertions, 3 deletions
diff --git a/tpl/cast/cast.go b/tpl/cast/cast.go index 999b31214..c864b5e32 100644 --- 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 d9baddf6b..bad65369f 100644 --- 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 b228040cd..08fb492d6 100644 --- 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 7aaa9291e..5771c98b5 100644 --- 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 61de2f72e..33eee7b27 100644 --- 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 4b02c426a..9045acd1c 100644 --- 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 09e4f5a40..8b24648cb 100644 --- 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 f5d32f449..4cb809df7 100644 --- 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 31b22dbcc..187f360d6 100644 --- 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 4c011b1ce..9a9f467bb 100644 --- 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 fcc6abc3d..0bc813dce 100644 --- 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 aca80ae9d..cc4a42d5d 100644 --- 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 dba0e5013..39bb153e0 100644 --- 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 f975726cc..641055224 100644 --- 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 8b30f3156..a20b2e503 100644 --- 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 64c36cc4d..4abd34e7f 100644 --- 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 1853cd727..91d533af9 100644 --- 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 a68809e65..8bc53ef49 100644 --- 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 d833cddc1..9a0533fe8 100644 --- 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 7a69e28a6..44d397e68 100644 --- 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 d56c85405..598124648 100644 --- 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 7ec1fec02..777e31c3e 100644 --- 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 7abf45ba2..754114b2b 100644 --- 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 ( |