go-sylixos/elvish
3
0
Fork 0
mirror of https://github.com/go-sylixos/elvish.git synced 2024-12-05 03:17:50 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Replace references to f{open close} in file module's elvdoc.

Browse Source
This commit is contained in:
Qi Xiao 2021-04-09 13:03:47 +01:00
parent 42d6e94dd7
commit 9b276a3431
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pkg/eval/mods/file/file.go
View File

@ -20,18 +20,19 @@ var fns = map[string]interface{}{
// file:open $filename
// ```
//
// Opens a file. Currently, `fopen` only supports opening a file for reading.
// File must be closed with `fclose` explicitly. Example:
// Opens a file. Currently, `open` only supports opening a file for reading.
// File must be closed with `close` explicitly. Example:
//
// ```elvish-transcript
// ~> cat a.txt
// This is
// a file.
// ~> f = (fopen a.txt)
// ~> use file
// ~> f = (file:open a.txt)
// ~> cat < $f
// This is
// a file.
// ~> fclose $f
// ~> close $f
// ```
//
// @cf close