utils: Add godoc

This commit is contained in:
Bjørn Erik Pedersen 2016-03-23 00:04:28 +01:00
parent df92fc31ca
commit da4d4164f1

View file

@ -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"); // Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License. // you may not use this file except in compliance with the License.
@ -19,6 +19,8 @@ import (
jww "github.com/spf13/jwalterweatherman" 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) { func CheckErr(err error, s ...string) {
if err == nil { if err == nil {
return return
@ -33,6 +35,7 @@ func CheckErr(err error, s ...string) {
jww.ERROR.Println(err) jww.ERROR.Println(err)
} }
// StopOnErr exits on any error after logging it.
func StopOnErr(err error, s ...string) { func StopOnErr(err error, s ...string) {
if err == nil { if err == nil {
return return