Merge pull request #246 from morrowc/master

Documentation update.
This commit is contained in:
Julien Laffaye 2022-02-01 17:25:55 -05:00 committed by GitHub
commit 02685330ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -71,20 +71,20 @@ func (w *Walker) Next() bool {
return true
}
//SkipDir tells the Next function to skip the currently processed directory
// SkipDir tells the Next function to skip the currently processed directory
func (w *Walker) SkipDir() {
w.descend = false
}
//Err returns the error, if any, for the most recent attempt by Next to
//visit a file or a directory. If a directory has an error, the walker
//will not descend in that directory
// Err returns the error, if any, for the most recent attempt by Next to
// visit a file or a directory. If a directory has an error, the walker
// will not descend in that directory
func (w *Walker) Err() error {
return w.cur.err
}
// Stat returns info for the most recent file or directory
// visited by a call to Step.
// visited by a call to Next.
func (w *Walker) Stat() *Entry {
return w.cur.entry
}