Skip to content

Commit 7a85e26

Browse files
committed
Doc patch: Make it clearer what the return value from ->parse is
1 parent 4429d49 commit 7a85e26

File tree

1 file changed

+5
-6
lines changed

1 file changed

+5
-6
lines changed

Parser.pm

+5-6
Original file line numberDiff line numberDiff line change
@@ -240,13 +240,12 @@ to the C<HTML::Parser> object:
240240
241241
=item $p->parse( $string )
242242
243-
Parse $string as the next chunk of the HTML document. The return
244-
value is normally a reference to the parser object (i.e. $p).
245-
Handlers invoked should not attempt to modify the $string in-place until
246-
$p->parse returns.
243+
Parse $string as the next chunk of the HTML document. Handlers invoked should
244+
not attempt to modify the $string in-place until $p->parse returns.
247245
248-
If an invoked event handler aborts parsing by calling $p->eof, then
249-
$p->parse() will return a FALSE value.
246+
If an invoked event handler aborts parsing by calling $p->eof, then $p->parse()
247+
will return a FALSE value. Otherwise the return value is a reference to the
248+
parser object ($p).
250249
251250
=item $p->parse( $code_ref )
252251

0 commit comments

Comments
 (0)