Doc #61705 [Asn->Csd]: Incorrect return type documented for CachingIterator->getInnerIterator()
| From: | aharvey@php.net | Date: | Fri, 13 Apr 2012 06:57:19 +0000 |
| Subject: | Doc #61705 [Asn->Csd]: Incorrect return type documented for CachingIterator->getInnerIterator() | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-8254@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=61705&edit=1
ID: 61705
Updated by: aharvey@php.net
Reported by: php-tracker at todofixthis dot com
Summary: Incorrect return type documented for
CachingIterator->getInnerIterator()
-Status: Assigned
+Status: Closed
Type: Documentation Problem
Package: Documentation problem
Operating System: N/A
PHP Version: Irrelevant
Assigned To: aharvey
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:
------------------------------------------------------------------------
[2012-04-13 06:57:16] aharvey@php.net
Automatic comment from SVN on behalf of aharvey
Revision: http://svn.php.net/viewvc/?view=revision&revision=325134
Log: Fix doc bug #61705 (Incorrect return type documented for
CachingIterator->getInnerIterator()).
------------------------------------------------------------------------
[2012-04-12 20:49:24] php-tracker at todofixthis dot com
Description:
------------
---
From manual page: http://www.php.net/cachingiterator.getinneriterator#refsect1-
cachingiterator.getinneriterator-description
---
The method signature is documented as:
> public void CachingIterator::getInnerIterator ( void )
This is incorrect; the return type should be
Iterator, per the documentation in
the "Return Values" section:
> Returns an object implementing the Iterator interface.
The corrected signature would look like this:
> public Iterator CachingIterator::getInnerIterator ( void )
Test script:
---------------
N/A
Expected result:
----------------
N/A
Actual result:
--------------
N/A
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=61705&edit=1