github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-07 20:30:36 -05:00
Code Issues Projects Releases Packages Wiki Activity

helpers: add some missing documentation

Browse source
This commit is contained in:
bep 2015-04-03 22:29:57 +02:00
parent be57ec5331
commit beb66c19a4
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
helpers/general.go
View file

@ -159,6 +159,8 @@ type DistinctErrorLogger struct {
m map[string]bool
}
// Printf will ERROR log the string returned from fmt.Sprintf given the arguments,
// but not if it has been logged before.
func (l *DistinctErrorLogger) Printf(format string, v ...interface{}) {
logStatement := fmt.Sprintf(format, v...)
l.RLock()
@ -176,6 +178,7 @@ func (l *DistinctErrorLogger) Printf(format string, v ...interface{}) {
l.Unlock()
}
// NewDistinctErrorLogger creates a new DistinctErrorLogger
func NewDistinctErrorLogger() *DistinctErrorLogger {
return &DistinctErrorLogger{m: make(map[string]bool)}
}
@ -183,6 +186,7 @@ func NewDistinctErrorLogger() *DistinctErrorLogger {
// Avoid spamming the logs with errors
var deprecatedLogger = NewDistinctErrorLogger()
// Deprecated logs ERROR logs about a deprecation, but only once for a given set of arguments' values.
func Deprecated(object, item, alternative string) {
deprecatedLogger.Printf("%s's %s is deprecated and will be removed in Hugo %s. Use %s instead.", object, item, NextHugoReleaseVersion(), alternative)
}
@ -227,7 +231,7 @@ func Seq(args ...interface{}) ([]int, error) {
return nil, errors.New("Invalid argument(s) to Seq")
}
var inc int = 1
var inc = 1
var last int
var first = intArgs[0]