Doc #76490 [Ver->Csd]: Documentation of Directory::read() makes no sense
| From: | cmb@php.net | Date: | Mon, 18 Jun 2018 10:54:56 +0000 |
| Subject: | Doc #76490 [Ver->Csd]: Documentation of Directory::read() makes no sense | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-15789@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=76490&edit=1
ID: 76490
Updated by: cmb@php.net
Reported by: teo8976 at gmail dot com
Summary: Documentation of Directory::read() makes no sense
-Status: Verified
+Status: Closed
Type: Documentation Problem
Package: Documentation problem
PHP Version: Irrelevant
-Assigned To:
+Assigned To: cmb
Block user comment: N
Private report: N
New Comment:
This bug has been fixed in the documentation's XML sources. Since the
online and downloadable versions of the documentation need some time
to get updated, we would like to ask you to be a bit patient.
Thank you for the report, and for helping us make our documentation better.
Previous Comments:
------------------------------------------------------------------------
[2018-06-18 10:54:26] cmb@php.net
Automatic comment from SVN on behalf of cmb
Revision: http://svn.php.net/viewvc/?view=revision&revision=345164
Log: Fix #76490: Documentation of Directory::read() makes no sense
------------------------------------------------------------------------
[2018-06-17 20:28:21] cmb@php.net
> Perhaps that was meant to read:
> "Same as readdir(), only dir_handle defaults to $this->handle."
That (cf. <https://github.com/php/php-src/blob/php-7.2.6/ext/standard/dir.c#L76>).
------------------------------------------------------------------------
[2018-06-17 14:51:56] teo8976 at gmail dot com
Description:
------------
---
From manual page: http://www.php.net/directory.read
---
All it says is:
"Same as readdir(), only dir_handle defaults to $this."
That makes no sense whatsoever. readdir() expects a RESOURCE as the 'dir_handle' argument,
not an object of class Directory, so there's no way that statement can be true, unless
readdir($dir_handle) can also accept a Directory object as handle, which is not documented. If that
is the case, then it should be properly documented in http://php.net/manual/en/function.readdir.php
Perhaps that was meant to read:
"Same as readdir(), only dir_handle defaults to $this->handle."
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=76490&edit=1