summaryrefslogtreecommitdiffstats
path: root/hugolib/planner.go
diff options
context:
space:
mode:
authorBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2016-04-07 16:05:23 +0200
committerBjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com>2016-04-07 16:05:23 +0200
commit05b888877db016e5c45711069272a39031377297 (patch)
tree6343257fc85557eb3457062751b2d9d8ebc313b7 /hugolib/planner.go
parent85bcac530adac2dcc21fdfd6acb902f76c3a5acf (diff)
huglib: Add even more missing GoDoc
See #2014
Diffstat (limited to 'hugolib/planner.go')
-rw-r--r--hugolib/planner.go2
1 files changed, 2 insertions, 0 deletions
diff --git a/hugolib/planner.go b/hugolib/planner.go
index 41a1676f6..22dd2586b 100644
--- a/hugolib/planner.go
+++ b/hugolib/planner.go
@@ -18,6 +18,8 @@ import (
"io"
)
+// ShowPlan prints a build plan to the given Writer.
+// Useful for debugging.
func (s *Site) ShowPlan(out io.Writer) (err error) {
if s.Source == nil || len(s.Source.Files()) <= 0 {
fmt.Fprintf(out, "No source files provided.\n")