This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Section 13.1 HTMLParser documentation error
Type: Stage:
Components: Documentation Versions: Python 2.3
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: fdrake Nosy List: fdrake, kemokid, rhettinger
Priority: normal Keywords:

Created on 2003-08-23 10:01 by kemokid, last changed 2022-04-10 16:10 by admin. This issue is now closed.

Messages (4)
msg17892 - (view) Author: Martin Baker (kemokid) Date: 2003-08-23 10:01
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!
msg17893 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2003-08-25 03:32
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.
msg17894 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2003-09-17 06:04
Logged In: YES 
user_id=80475

My fix didn't take.
Re-opening and assigning to Fred so the job gets done right.
msg17895 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2004-04-01 04:45
Logged In: YES 
user_id=3066

Hmm, I must not have noticed this report when I fixed the
bug.  This was fixed in Doc/perl/python.perl 1.144.

I've backported the fix to Python 2.3.4 as
Doc/perl/python.perl 1.137.8.2.

This problem was only an issue for the HTML and iSilo
conversions (the later only because it relied on the HTML
conversion).
History
Date User Action Args
2022-04-10 16:10:48adminsetgithub: 39112
2003-08-23 10:01:50kemokidcreate