From: Fred Drake <fdrake@acm.org>
Date: Tue, 23 Aug 2005 04:06:46 +0000 (+0000)
Subject: add note about "markupbase" not being intended for direct use
X-Git-Tag: v2.5a0~1486
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=7ed44e52aa8a238bfbcb39d89df477e9bafc1837;p=thirdparty%2FPython%2Fcpython.git

add note about "markupbase" not being intended for direct use
(closes SF bug #736659, patch #901369)
---

diff --git a/Lib/markupbase.py b/Lib/markupbase.py
index b8d8d5d27edb..3d00a74a92e9 100644
--- a/Lib/markupbase.py
+++ b/Lib/markupbase.py
@@ -1,4 +1,10 @@
-"""Shared support for scanning document type declarations in HTML and XHTML."""
+"""Shared support for scanning document type declarations in HTML and XHTML.
+
+This module is used as a foundation for the HTMLParser and sgmllib
+modules (indirectly, for htmllib as well).  It has no documented
+public API and should not be used directly.
+
+"""
 
 import re