com doc/ja: fgets() can return false: reference/filesystem/functions/fgets.xml

[email protected] (Yoshinari Takaoka) Thu, 28 Jan 2021 15:32:16 +0000
Newsgroups php.doc.ja
Message-ID <[email protected]>
Commit:    9f33b89c8ee462fb6c308c56ac8a8cd063c76d36
Author:    Yoshinari Takaoka <[email protected]>         Fri, 29 Jan 2021 00:32:16 +0900
Parents:   5a8b06f09232ef0028dbf4c7ba4f086cb7a3847e
Branches:  master

Link:       http://git.php.net/?p=doc/ja.git;a=commitdiff;h=9f33b89c8ee462fb6c308c56ac8a8cd063c76d36

Log:
fgets() can return false

As described in the docs "If there is no more data to read in the file
pointer, then false is returned."

Co-authored-by: Christoph M. Becker <[email protected]>

Closes GH-425.

Changed paths:
  M  reference/filesystem/functions/fgets.xml


Diff:
diff --git a/reference/filesystem/functions/fgets.xml b/reference/filesystem/functions/fgets.xml
index 36b7452cf1..fdccc5199e 100644
--- a/reference/filesystem/functions/fgets.xml
+++ b/reference/filesystem/functions/fgets.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <!-- $Revision$ -->
-<!-- EN-Revision: 4754397753fd79f1c846868b66a2448babab1c54 Maintainer: hirokawa Status: ready -->
+<!-- EN-Revision: 359f21684be3993e948f8f7c994c125971665535 Maintainer: hirokawa Status: ready -->
 <!-- CREDITS: shimooka,mumumu -->
 <refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.fgets">
  <refnamediv>
@@ -11,7 +11,7 @@
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
-   <type>string</type><methodname>fgets</methodname>
+   <type class="union"><type>string</type><type>false</type></type><methodname>fgets</methodname>
    <methodparam><type>resource</type><parameter>handle</parameter></methodparam>
    <methodparam choice="opt"><type>int</type><parameter>length</parameter></methodparam>
   </methodsynopsis>