| Subject: | Patch: Clarify Documentation for clean() |
The documentation for HTML::Tidy's clean() method doesn't describe its return value clearly. For a more precise description, see the attached patch which applies against version 1.06.
In case you're interested, I describe the background for this patch in my use.perl journal:
http://use.perl.org/~tomhukins/journal/27445
Thanks,
Tom
--- lib/HTML/Tidy.pm.old Fri Aug 19 15:30:54 2005
+++ lib/HTML/Tidy.pm Sun Nov 6 20:26:27 2005
@@ -241,8 +241,8 @@
Cleans a string, or list of strings, that make up a single HTML file.
-Returns true if all went OK, or false if there was some problem calling
-tidy, or parsing tidy's output.
+Returns a string containing a cleaned version of the input strings, or
+false if there was some problem calling tidy, or parsing tidy's output.
=cut