Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adapt pydoc to new doc system #46191

Closed
birkenfeld opened this issue Jan 21, 2008 · 8 comments
Closed

Adapt pydoc to new doc system #46191

birkenfeld opened this issue Jan 21, 2008 · 8 comments
Assignees
@birkenfeld
Labels
stdlib Python modules in the Lib dir

Comments

@birkenfeld
Copy link
Member

BPO 1883
Nosy @birkenfeld, @amauryfa, @hdiogenes
Files
  • py3k-test_pydoc.patch: First try on automated tests for pydoc
  • py3k-pydoc.doc-cleanup.patch: Removed duplicated code from pydoc.doc
    		•

    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']
    @birkenfeld
    Copy link
    Member Author

    so that this doesn't get lost...

    @birkenfeld birkenfeld self-assigned this Jan 21, 2008
    @birkenfeld birkenfeld added the stdlib Python modules in the Lib dir label Jan 21, 2008
    @gpolo gpolo mannequin added type-bug An unexpected behavior, bug, or error and removed type-bug An unexpected behavior, bug, or error labels Jan 22, 2008
    @hdiogenes
    Copy link
    Mannequin

    hdiogenes mannequin commented 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
    Copy link
    Member

    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
    Copy link
    Member

    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
    Copy link
    Mannequin

    hdiogenes mannequin commented 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
    Copy link
    Mannequin

    hdiogenes mannequin commented 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
    Copy link
    Member

    Anyway, the doc-cleanup.patch is still pending... ;)
    No, I already removed the duplicated code in r62505.

    @birkenfeld
    Copy link
    Member Author

    OK, this is fixed by including topic help as a separate module, and not
    relying on the HTML documentation, in r63871.

    @ezio-melotti ezio-melotti transferred this issue from another repository Apr 10, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Assignees

    @birkenfeld birkenfeld

    Labels
    stdlib Python modules in the Lib dir
    Projects
    None yet
    Milestone
    No milestone
    Development

    No branches or pull requests
    2 participants
    @birkenfeld @amauryfa