Doc #65794 [Opn->Csd]: wrong Return Values description
| From: | aharvey@php.net | Date: | Tue, 01 Oct 2013 17:37:30 +0000 |
| Subject: | Doc #65794 [Opn->Csd]: wrong Return Values description | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-10346@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=65794&edit=1
ID: 65794
Updated by: aharvey@php.net
Reported by: m dot gondar dot au at gmail dot com
Summary: wrong Return Values description
-Status: Open
+Status: Closed
Type: Documentation Problem
Package: Documentation problem
PHP Version: Irrelevant
-Assigned To:
+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:
------------------------------------------------------------------------
[2013-10-01 17:37:25] aharvey@php.net
Automatic comment from SVN on behalf of aharvey
Revision: http://svn.php.net/viewvc/?view=revision&revision=331631
Log: Fix the return value description for tidy::body(), and remove the long-obviated
warning about libtidy not implementing it (I checked; it does).
Fixes doc bug #65794 (wrong Return Values description).
------------------------------------------------------------------------
[2013-10-01 03:26:38] m dot gondar dot au at gmail dot com
Description:
------------
---
From manual page: http://www.php.net/tidy.body#refsect1-tidy.body-returnvalues
---
Return values description is inconsistant with main description.
"Return values" should be "Returns a tidyNode object starting from the <body>
tag
of the tidy parse tree." and not as currently "Returns the detected HTML version."
Test script:
---------------
example provided on the same page can be used:
<?php
$html = '
<html>
<head>
<title>test</title>
</head>
<body>
<p>paragraph</p>
</body>
</html>';
$tidy = tidy_parse_string($html);
$body = $tidy->Body();
echo $body->value;
?>
Expected result:
----------------
"Return values" should be "Returns a tidyNode object starting from the <body>
tag
of the tidy parse tree."
Actual result:
--------------
"Return values" is "Returns the detected HTML version."
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=65794&edit=1