aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRoger Peppe <rogpeppe@gmail.com>2024-01-05 12:47:56 +0000
committerroger peppe <rogpeppe@gmail.com>2024-01-09 08:50:19 +0000
commit821f94103b2980758cdb21ac6ae834ef0a07235a (patch)
tree3180f7e0e8759671bc7ffef0e1d83d4adb15ab36
parentb7c630dc3ac3f43b2294f803f26f512d75a54fc6 (diff)
downloadgo-821f94103b2980758cdb21ac6ae834ef0a07235a.tar.gz
go-821f94103b2980758cdb21ac6ae834ef0a07235a.zip
io/fs,path/filepath: fix typo in SkipAll/SkipDir doc
Also make the reference into a doc link. Change-Id: Ib112307a65b65c8f963abf60aa92cb1942de940c Reviewed-on: https://go-review.googlesource.com/c/go/+/554295 Reviewed-by: Dmitri Shuralyov <dmitshur@google.com> Reviewed-by: Matthew Dempsky <mdempsky@google.com> Reviewed-by: Dmitri Shuralyov <dmitshur@golang.org> LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
-rw-r--r--src/io/fs/walk.go4
-rw-r--r--src/path/filepath/path.go4
2 files changed, 4 insertions, 4 deletions
diff --git a/src/io/fs/walk.go b/src/io/fs/walk.go
index 48145d4cfc..2e8a8db111 100644
--- a/src/io/fs/walk.go
+++ b/src/io/fs/walk.go
@@ -9,12 +9,12 @@ import (
"path"
)
-// SkipDir is used as a return value from WalkDirFuncs to indicate that
+// SkipDir is used as a return value from [WalkDirFunc] to indicate that
// the directory named in the call is to be skipped. It is not returned
// as an error by any function.
var SkipDir = errors.New("skip this directory")
-// SkipAll is used as a return value from WalkDirFuncs to indicate that
+// SkipAll is used as a return value from [WalkDirFunc] to indicate that
// all remaining files and directories are to be skipped. It is not returned
// as an error by any function.
var SkipAll = errors.New("skip everything and stop the walk")
diff --git a/src/path/filepath/path.go b/src/path/filepath/path.go
index 075cea848e..2af0f5b04c 100644
--- a/src/path/filepath/path.go
+++ b/src/path/filepath/path.go
@@ -386,12 +386,12 @@ func Rel(basepath, targpath string) (string, error) {
return targ[t0:], nil
}
-// SkipDir is used as a return value from WalkFuncs to indicate that
+// SkipDir is used as a return value from [WalkFunc] to indicate that
// the directory named in the call is to be skipped. It is not returned
// as an error by any function.
var SkipDir error = fs.SkipDir
-// SkipAll is used as a return value from WalkFuncs to indicate that
+// SkipAll is used as a return value from [WalkFunc] to indicate that
// all remaining files and directories are to be skipped. It is not returned
// as an error by any function.
var SkipAll error = fs.SkipAll