Repository navigation
Adapt pydoc to new doc system #46191
Description
| BPO | 1883 |
|---|---|
| Nosy | @birkenfeld, @amauryfa, @hdiogenes |
| Files |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2008-06-01.21:07:16.166>
created_at = <Date 2008-01-21.17:14:07.443>
labels = ['library']
title = 'Adapt pydoc to new doc system'
updated_at = <Date 2008-06-01.21:07:16.127>
user = 'https://github.com/birkenfeld'bugs.python.org fields:
activity = <Date 2008-06-01.21:07:16.127>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2008-06-01.21:07:16.166>
closer = 'georg.brandl'
components = ['Library (Lib)']
creation = <Date 2008-01-21.17:14:07.443>
creator = 'georg.brandl'
dependencies = []
files = ['10082', '10103']
hgrepos = []
issue_num = 1883
keywords = ['patch']
message_count = 8.0
messages = ['61418', '65710', '65711', '65749', '65772', '65916', '65917', '67602']
nosy_count = 3.0
nosy_names = ['georg.brandl', 'amaury.forgeotdarc', 'hdiogenes']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue1883'
versions = ['Python 2.6', 'Python 3.0']
Activity
birkenfeld commentedon Jan 21, 2008
so that this doesn't get lost...
hdiogenes commentedon Apr 24, 2008
It looks like there are no automated tests for pydoc; it's even listed in test_sundry.py.
There's only one file Lib/test/pydocfodder.py which defines "Something just to look at
via pydoc", but isn't used anywhere (I grepped and found nothing).
I've attached a patch just to document one point where pydoc behavior differs from 2.5 to
3.0: describe() used to return 'instance of ClassX', now it returns only 'ClassX' (which
means this test will pass in 2.5 but not in 3.0).
Functions main and test_main were copied from test_modulefinder.
amauryfa commentedon Apr 24, 2008
It's not a difference between versions, but a difference between
old-style and new-style classes (which derive from object).
In 3.0, all classes are new-style...
amauryfa commentedon Apr 24, 2008
Humberto, I added your test file in trunk.
I added some other tests: now pydocfodder.py is used by a basic "smoke
test".
The tests revealed two bugs in python3.0... Thanks!
hdiogenes commentedon Apr 25, 2008
Amaury, seems that there's duplicated from render_doc inside pydoc.doc. I
removed it and everything kept working, including the new basic tests.
hdiogenes commentedon Apr 28, 2008
According to Georg, the "adaptation" referred by this issue is just about
changing the URLs in the documentation to point appropriately to the URLs
generated by the new doc system.
Anyway, the doc-cleanup.patch is still pending... ;)
amauryfa commentedon Apr 28, 2008
birkenfeld commentedon Jun 1, 2008
OK, this is fixed by including topic help as a separate module, and not
relying on the HTML documentation, in r63871.