From eca64ff6215ba366eba7563c5ea9a16e0ee8e28e Mon Sep 17 00:00:00 2001 From: Vincent Batts Date: Thu, 16 Feb 2017 10:44:52 -0500 Subject: [PATCH] walk: update the comment Signed-off-by: Vincent Batts --- walk.go | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/walk.go b/walk.go index 3af4110..5ddbf6c 100644 --- a/walk.go +++ b/walk.go @@ -25,9 +25,10 @@ var ExcludeNonDirectories = func(path string, info os.FileInfo) bool { var defaultSetKeywords = []KeyVal{"type=file", "nlink=1", "flags=none", "mode=0664"} -// Walk from root directory and assemble the DirectoryHierarchy. excludes -// provided are used to skip paths. keywords are the set to collect from the -// walked paths. The recommended default list is DefaultKeywords. +// Walk from root directory and assemble the DirectoryHierarchy +// * `excludes` provided are used to skip paths +// * `keywords` are the set to collect from the walked paths. The recommended default list is DefaultKeywords. +// * `fsEval` is the interface to use in evaluating files. If `nil`, then DefaultFsEval is used. func Walk(root string, excludes []ExcludeFunc, keywords []Keyword, fsEval FsEval) (*DirectoryHierarchy, error) { if fsEval == nil { fsEval = DefaultFsEval{}