Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/gohugoio/hugo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/tpl/math
diff options
context:
space:
mode:
authorJorin Vogel <hi@jorin.me>2017-08-02 15:25:05 +0300
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2017-08-03 16:57:51 +0300
commit81c13171a985b89f2af6682dbd1d4b8766cb9af7 (patch)
treedb39d78bbe6da0ea3f3dd3d2f94c7e1571ad8fd6 /tpl/math
parent9891c0fb0eb274b8a95b62c40070a87a6e04088c (diff)
Add some missing doc comments
As pointed out by the linter, some exported functions and types are missing doc comments. The linter warnings have been reduced from 194 to 116. Not all missing comments have been added in this commit though.
Diffstat (limited to 'tpl/math')
-rw-r--r--tpl/math/math.go5
1 files changed, 5 insertions, 0 deletions
diff --git a/tpl/math/math.go b/tpl/math/math.go
index 303f029af..f45488166 100644
--- a/tpl/math/math.go
+++ b/tpl/math/math.go
@@ -29,14 +29,17 @@ func New() *Namespace {
// Namespace provides template functions for the "math" namespace.
type Namespace struct{}
+// Add adds two numbers.
func (ns *Namespace) Add(a, b interface{}) (interface{}, error) {
return DoArithmetic(a, b, '+')
}
+// Div divides two numbers.
func (ns *Namespace) Div(a, b interface{}) (interface{}, error) {
return DoArithmetic(a, b, '/')
}
+// Log returns the natural logarithm of a number.
func (ns *Namespace) Log(a interface{}) (float64, error) {
af, err := cast.ToFloat64E(a)
@@ -84,10 +87,12 @@ func (ns *Namespace) ModBool(a, b interface{}) (bool, error) {
return res == int64(0), nil
}
+// Mul multiplies two numbers.
func (ns *Namespace) Mul(a, b interface{}) (interface{}, error) {
return DoArithmetic(a, b, '*')
}
+// Sub substracts two numbers.
func (ns *Namespace) Sub(a, b interface{}) (interface{}, error) {
return DoArithmetic(a, b, '-')
}