hugo

commit da4d4164f1a834d1a8b84f33cb49b4fc1999d4dc
parent df92fc31caf84edfaa6d0076227e1f5f009a4198
Author: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date:   Wed, 23 Mar 2016 00:04:28 +0100

utils: Add godoc

Diffstat:
M
utils/utils.go
 | 
5
++++-

1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/utils/utils.go b/utils/utils.go
@@ -1,4 +1,4 @@
-// Copyright 2015 The Hugo Authors. All rights reserved.
+// Copyright 2016 The Hugo Authors. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -19,6 +19,8 @@ import (
 	jww "github.com/spf13/jwalterweatherman"
 )
 
+// CheckErr logs the messages given and then the error.
+// TODO(bep) Remove this package.
 func CheckErr(err error, s ...string) {
 	if err == nil {
 		return
@@ -33,6 +35,7 @@ func CheckErr(err error, s ...string) {
 	jww.ERROR.Println(err)
 }
 
+// StopOnErr exits on any error after logging it.
 func StopOnErr(err error, s ...string) {
 	if err == nil {
 		return