Fix File.Save() documentation

go-goyave · Jan 11, 2020 · 1beaee7 · 1beaee7
1 parent df23af0
commit 1beaee7
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs_src/src/guide/advanced/helpers.md b/docs_src/src/guide/advanced/helpers.md
@@ -148,7 +148,7 @@ Writes the given file on the disk.
 Appends a timestamp to the given file name to avoid duplicate file names.
 The file is not readable anymore once saved as its FileReader has already been closed.
 
-Returns the actual path to the saved file.
+Returns the actual file name.
 
 | Parameters             | Return   |
 |------------------------|----------|

diff --git a/helper/filesystem/file.go b/helper/filesystem/file.go
@@ -18,7 +18,7 @@ type File struct {
 // The file is not readable anymore once saved as its FileReader has already been
 // closed.
 //
-// Returns the actual path to the saved file.
+// Returns the actual file name.
 func (file *File) Save(path string, name string) string {
 	name = timestampFileName(name)
 	writer, err := os.OpenFile(path+string(os.PathSeparator)+name, os.O_WRONLY|os.O_CREATE, 0660)