From: Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>
Date: Tue, 22 Mar 2016 23:04:28 +0000 (+0100)
Subject: utils: Add godoc
X-Git-Tag: v0.16~191
X-Git-Url: http://git.maquefel.me/?a=commitdiff_plain;h=da4d4164;p=brevno-suite%2Fhugo

utils: Add godoc
---

diff --git a/utils/utils.go b/utils/utils.go
index 6f4264cc..a3329c4a 100644
--- 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