jeff <frey...@gmail.com> added the comment:
On Thu, Jun 17, 2010 at 3:30 PM, Terry J. Reedy <rep...@bugs.python.org> wrote:
> In order for the doc maintainers to add an entry, someone knowledgeable must
> write it. Your paragraph of explanation is a start, but more editing is
> needed.
>
> Looking at dir(html.parser.HTMLParser) and help(...), I see that there are
> several public internal methods. Some have doc strings that show up with
> help(), some do not. I thing all should. Some are defined on HTMLParser and
> some inherited from the undocumented (I believe) _markupbase.ParserBase.
>
> I see that there are also several (completely undocumented except fir dir())
> private ('_xyz') internal methods. This implies to me that the public
> internal methods were made public rather than private because there might be
> reason to override them. If so, perhaps there should be a new subsection on
> public internal methods to explain what is what with them. What do you think?
> Document just one, some, or all?
Terry,
I'm looking at the HTMLParser code, and I only see unknown_decl as a
method in there that is: a) not marked as internal or doing a lot, b)
not documented. There are a number of methods which should probably be
refactored to be _methodname rather than methodname, but that's beyond
the scope of this report.
HTMLParser.unknown_decl(data)ΒΆ
Method called when an unrecognized SGML declaration is read by the
parser. The data parameter will be the entire contents of the
declaration inside the <!...> markup. It is sometimes useful to be be
overridden by a derived class; the base class implementation throws an
HTMLParseError.
There may be other undocumented methods showing up, but if so they're
part of a parent class.
Thanks,
Jeff
----------
_______________________________________
Python tracker <rep...@bugs.python.org>
<http://bugs.python.org/issue3874>
_______________________________________
_______________________________________________
Python-bugs-list mailing list
Unsubscribe:
http://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
