cybercyst/go
1
0
Fork 0
mirror of https://github.com/golang/go.git synced 2025-05-05 15:43:04 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fs: clarify documentation for ReadDir method

Browse Source 
The fs.ReadDir method behaves the same way as
os.ReadDir, in that when n <= 0, ReadDir returns
all DirEntry values remaining in the dictionary.

Update the comment to reflect that only remaining
DirEntry values are returned (not all entries),
for subsequent calls.

Fixes #69301

Change-Id: I41ef7ef1c8e3fe7d64586f5297512697dc60dd40
Reviewed-on: https://go-review.googlesource.com/c/go/+/663215
Reviewed-by: Keith Randall <khr@google.com>
Reviewed-by: Sean Liao <sean@liao.dev>
Auto-Submit: Sean Liao <sean@liao.dev>
Reviewed-by: Jorropo <jorropo.pgm@gmail.com>
Reviewed-by: David Chase <drchase@google.com>
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
This commit is contained in:
Matthew Burton 2025-04-05 16:56:42 -04:00 committed by Gopher Robot
parent a4d0269a4f
commit ad0434200c
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/io/fs/fs.go
View File

@ -129,7 +129,7 @@ type ReadDirFile interface {
// At the end of a directory, the error is io.EOF. // At the end of a directory, the error is io.EOF.
// (ReadDir must return io.EOF itself, not an error wrapping io.EOF.) // (ReadDir must return io.EOF itself, not an error wrapping io.EOF.)
// //
// If n <= 0, ReadDir returns all the DirEntry values from the directory // If n <= 0, ReadDir returns all remaining DirEntry values from the directory
// in a single slice. In this case, if ReadDir succeeds (reads all the way // in a single slice. In this case, if ReadDir succeeds (reads all the way
// to the end of the directory), it returns the slice and a nil error. // to the end of the directory), it returns the slice and a nil error.
// If it encounters an error before the end of the directory, // If it encounters an error before the end of the directory,