mirrors/phobos
1
0
Fork 0
mirror of https://github.com/dlang/phobos.git synced 2025-04-29 06:30:28 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

std.stdio: clarify "not opened" documentation

Browse source 
when the code is `!isOpen` it now means:
- in exception documentation it's now always saying "not opened" (or similar, it's clear the file is in error state in that case)
- in general documentation it now always says "closed or not yet opened" (to avoid mistaking it with eof)
- in runtime error messages it always says "unopened"
This commit is contained in:
Jan Jurzitza 2022-01-07 10:30:23 +01:00 • committed by The Dlang Bot
parent 10b9721530
commit a5c3c24b71
1 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

8
std/stdio.d
View file

@ -957,7 +957,7 @@ Throws: `Exception` if the file is not opened.
} }
/** /**
If the file is not opened, returns `true`. Otherwise, returns If the file is closed or not yet opened, returns `true`. Otherwise, returns
$(HTTP cplusplus.com/reference/clibrary/cstdio/ferror.html, ferror) for $(HTTP cplusplus.com/reference/clibrary/cstdio/ferror.html, ferror) for
the file handle. the file handle.
*/ */
@ -1013,8 +1013,8 @@ Throws: `ErrnoException` on failure if closing the file.
} }
/** /**
If the file was unopened, succeeds vacuously. Otherwise closes the If the file was closed or not yet opened, succeeds vacuously. Otherwise
file (by calling $(HTTP closes the file (by calling $(HTTP
cplusplus.com/reference/clibrary/cstdio/fclose.html, fclose)), cplusplus.com/reference/clibrary/cstdio/fclose.html, fclose)),
throwing on error. Even if an exception is thrown, afterwards the $(D throwing on error. Even if an exception is thrown, afterwards the $(D
File) object is empty. This is different from `detach` in that it File) object is empty. This is different from `detach` in that it
@ -1042,7 +1042,7 @@ Throws: `ErrnoException` on error.
} }
/** /**
If the file is not opened, succeeds vacuously. Otherwise, returns If the file is closed or not yet opened, succeeds vacuously. Otherwise, returns
$(HTTP cplusplus.com/reference/clibrary/cstdio/_clearerr.html, $(HTTP cplusplus.com/reference/clibrary/cstdio/_clearerr.html,
_clearerr) for the file handle. _clearerr) for the file handle.
*/ */