[Python-bugs-list] [ python-Bugs-793702 ] Section 13.1 HTMLParser documentation error

[SourceForge.net]

Bugs item #793702, was opened at 2003-08-23 05:01
Message generated for change (Comment added) made by rhettinger
You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=793702&group_id=5470

Category: Documentation
>Group: Python 2.3
>Status: Open
>Resolution: None
>Priority: 5
Submitted By: Martin Baker (kemokid)
>Assigned to: Fred L. Drake, Jr. (fdrake)
Summary: Section 13.1 HTMLParser documentation error

Initial Comment:
The description for handle_comment() says:



     The comment argument is a string containing the

text between the "<!-" and "->" delimiters, but not the

delimiters themselves. For example, the comment

"<!-text->" will cause this method to be called with

the argument 'text'.



This is incorrect - the comment delimiters are "<!--"

and "-->" (two hyphens, not just one). Purusing the

code, it appears that the module itself behaves

correctly, so this is only a very minor documentation

bug, but to a HTML newbie, it could be an incredibly

frustrating one.



This was seen on 2003/8/23 at

http://www.python.org/doc/current/lib/module-HTMLParser.html



And a big thank you to all Pythonic volunteers!

----------------------------------------------------------------------

>Comment By: Raymond Hettinger (rhettinger)
Date: 2003-09-17 01:04

Message:
Logged In: YES 
user_id=80475

My fix didn't take.

Re-opening and assigning to Fred so the job gets done right.

----------------------------------------------------------------------

Comment By: Raymond Hettinger (rhettinger)
Date: 2003-08-24 22:32

Message:
Logged In: YES 
user_id=80475

Thanks for the bug report.

It looks like TeX was considering -- as a special character 

and only printing it once.  Escaping the hyphen ought to fix 

it.

----------------------------------------------------------------------

You can respond by visiting: 
https://sourceforge.net/tracker/?func=detail&atid=105470&aid=793702&group_id=5470