summaryrefslogtreecommitdiffstats
path: root/Lib/test/test_pydoc.py
diff options
context:
space:
mode:
authorAlexander Belopolsky <alexander.belopolsky@gmail.com>2010-11-18 01:58:16 (GMT)
committerAlexander Belopolsky <alexander.belopolsky@gmail.com>2010-11-18 01:58:16 (GMT)
commit4979b9b91ebfaefa53e44546097db7a5eab7e547 (patch)
tree141e0ec1e03d6f632b66a92a6dad7c67d7c62c8d /Lib/test/test_pydoc.py
parent6083170858771dc8098be3c6651616419b76aeaa (diff)
downloadcpython-4979b9b91ebfaefa53e44546097db7a5eab7e547.zip
cpython-4979b9b91ebfaefa53e44546097db7a5eab7e547.tar.gz
cpython-4979b9b91ebfaefa53e44546097db7a5eab7e547.tar.bz2
Merged revisions 86504 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k ........ r86504 | alexander.belopolsky | 2010-11-17 20:52:54 -0500 (Wed, 17 Nov 2010) | 15 lines Issue #10446: Several changes to module documentation generated by pydoc: 1. Online reference manual link is now version-specific and the 'MODULE DOCS' section renamed to 'MODULE REFERENCE'. 2. 'FILE' section is moved to the end of the file. 3. Special names processed by pydoc such as __version__ or __credits__ are now excluded from the DATA section. 4. Defined __all__ to prevent pydoc from exposing undocumented details about itself. 5. Removed Python 2.3 compatibility code. ........
Diffstat (limited to 'Lib/test/test_pydoc.py')
-rw-r--r--Lib/test/test_pydoc.py16
1 files changed, 6 insertions, 10 deletions
diff --git a/Lib/test/test_pydoc.py b/Lib/test/test_pydoc.py
index 14ab6f1..f7aa487 100644
--- a/Lib/test/test_pydoc.py
+++ b/Lib/test/test_pydoc.py
@@ -18,9 +18,6 @@ expected_text_pattern = \
"""
NAME
test.pydoc_mod - This is a test module for test_pydoc
-
-FILE
- %s
%s
CLASSES
builtins.object
@@ -68,9 +65,7 @@ FUNCTIONS
nodoc_func()
DATA
- __author__ = 'Benjamin Peterson'
- __credits__ = 'Nobody'
- __version__ = '1.2.3.4'
+ __xyz__ = 'X, Y and Z'
VERSION
1.2.3.4
@@ -80,6 +75,9 @@ AUTHOR
CREDITS
Nobody
+
+FILE
+ %s
""".strip()
expected_html_pattern = \
@@ -164,9 +162,7 @@ war</tt></dd></dl>
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
\x20\x20\x20\x20
<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
-<td width="100%%"><strong>__author__</strong> = 'Benjamin Peterson'<br>
-<strong>__credits__</strong> = 'Nobody'<br>
-<strong>__version__</strong> = '1.2.3.4'</td></tr></table><p>
+<td width="100%%"><strong>__xyz__</strong> = 'X, Y and Z'</td></tr></table><p>
<table width="100%%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#7799ee">
<td colspan=3 valign=bottom>&nbsp;<br>
@@ -249,7 +245,7 @@ class PyDocDocTest(unittest.TestCase):
def test_text_doc(self):
result, doc_loc = get_pydoc_text(pydoc_mod)
expected_text = expected_text_pattern % \
- (inspect.getabsfile(pydoc_mod), doc_loc)
+ (doc_loc, inspect.getabsfile(pydoc_mod))
if result != expected_text:
print_diffs(expected_text, result)
self.fail("outputs are not equal, see diff above")