os: document that Remove removes only empty directories

Fixes #26507

Change-Id: I967e4f897ca891c70ca8bb0e66b984530c240815
Reviewed-on: https://go-review.googlesource.com/127835
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
This commit is contained in:
Ian Lance Taylor 2018-08-03 09:55:44 -07:00 committed by Rob Pike
parent 669ac1228a
commit 0bad63437e

View file

@ -296,7 +296,7 @@ func Truncate(name string, size int64) error {
return nil
}
// Remove removes the named file or directory.
// Remove removes the named file or (empty) directory.
// If there is an error, it will be of type *PathError.
func Remove(name string) error {
// System call interface forces us to know