php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #65794 wrong Return Values description
Submitted: 2013-10-01 03:26 UTC Modified: 2013-10-01 17:37 UTC
From: m dot gondar dot au at gmail dot com Assigned: aharvey (profile)
Status: Closed Package: Documentation problem
PHP Version: Irrelevant OS:
Private report: No CVE-ID: None
Welcome back! If you're the original bug submitter, here's where you can edit the bug or add additional notes.
If you forgot your password, you can retrieve your password here.
Password:
Status:
Package:
Bug Type:
Summary:
From: m dot gondar dot au at gmail dot com
New email:
PHP Version: OS:

 

 [2013-10-01 03:26 UTC] 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."

Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2013-10-01 17:37 UTC] aharvey@php.net
Automatic comment from SVN on behalf of aharvey
Revision: http://svn.php.net/viewvc/?view=revision&amp;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 17:37 UTC] aharvey@php.net
-Status: Open +Status: Closed -Assigned To: +Assigned To: aharvey
 [2013-10-01 17:37 UTC] aharvey@php.net
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.


 
PHP Copyright © 2001-2026 The PHP Group
All rights reserved.
Last updated: Thu Oct 08 00:00:02 2026 UTC