os: change Readdirnames doc to follow that of Readdir

The two methods act the same, so make their documentation similar so
that people don't think they act differently.

Change-Id: If224692ef50870faf855d789380a614d1e724132
Reviewed-on: https://go-review.googlesource.com/c/go/+/188137
Reviewed-by: Rob Pike <r@golang.org>
This commit is contained in:
Ian Lance Taylor 2019-07-30 06:28:57 -07:00 committed by Rob Pike
parent d178c5888f
commit fc821667dd

View File

@ -26,7 +26,10 @@ func (f *File) Readdir(n int) ([]FileInfo, error) {
return f.readdir(n)
}
// Readdirnames reads and returns a slice of names from the directory f.
// Readdirnames reads the contents of the directory associated with file
// and returns a slice of up to n names of files in the directory,
// in directory order. Subsequent calls on the same file will yield
// further names.
//
// If n > 0, Readdirnames returns at most n names. In this case, if
// Readdirnames returns an empty slice, it will return a non-nil error