This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Wrong link in xml.etree documentation
Type: behavior Stage: resolved
Components: Library (Lib) Versions: Python 3.1, Python 3.2, Python 2.7, Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: brian.curtin Nosy List: brian.curtin, eric.araujo, ezio.melotti, georg.brandl, mangus.wahberg
Priority: normal Keywords: patch

Created on 2010-03-24 23:01 by mangus.wahberg, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue8225.diff brian.curtin, 2010-03-25 03:14 patch against trunk
Messages (6)
msg101655 - (view) Author: Mangus Wahberg (mangus.wahberg) Date: 2010-03-24 23:01
When using the interactive python help and entering xml.etree the help page contains a link faulty link to the online documentation.

The link in the help page is:

 MODULE DOCS
    http://docs.python.org/library/xml.etree

But the correct link is:
http://docs.python.org/library/xml.etree.elementtree
msg101671 - (view) Author: Brian Curtin (brian.curtin) * (Python committer) Date: 2010-03-25 03:14
I believe the problem is with pydoc. In the case of xml.etree, I don't think it should be displaying anything for MODULE DOCS.

help(xml.etree.ElementTree) does display the proper link.

The attached patch and test fixes the problem.
msg101974 - (view) Author: Brian Curtin (brian.curtin) * (Python committer) Date: 2010-03-31 03:23
Fixed in trunk (r79518), release26-maint (r79519), py3k (r79520), and release31-maint (r79521).
msg102018 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2010-03-31 16:33
Hello

Is it ok that the code checks “object.__name__ not in ('xml.etree')”? Looks like a failed single-item tuple to me. Besides, what about using a simple “!=”?

Regards
msg102021 - (view) Author: Brian Curtin (brian.curtin) * (Python committer) Date: 2010-03-31 17:23
Good catch. That was intended to be a single tuple because the other check above is a tuple, but because this really only checks one thing it could be a != until its necessary to be a tuple. I'll fix it.
msg102023 - (view) Author: Brian Curtin (brian.curtin) * (Python committer) Date: 2010-03-31 17:50
Made the change in r79529 through 79532.
History
Date User Action Args
2022-04-11 14:56:59adminsetgithub: 52472
2010-03-31 17:50:33brian.curtinsetmessages: + msg102023
2010-03-31 17:23:57brian.curtinsetmessages: + msg102021
2010-03-31 16:33:08eric.araujosetnosy: + eric.araujo
messages: + msg102018
2010-03-31 03:23:26brian.curtinsetstatus: open -> closed
versions: + Python 3.1, Python 2.7, Python 3.2
messages: + msg101974

resolution: fixed
stage: patch review -> resolved
2010-03-25 03:15:04brian.curtinsettype: performance -> behavior
2010-03-25 03:14:42brian.curtinsetfiles: + issue8225.diff

type: performance
assignee: georg.brandl -> brian.curtin
components: + Library (Lib), - Documentation

keywords: + patch
nosy: + brian.curtin
messages: + msg101671
stage: patch review
2010-03-24 23:02:51ezio.melottisetpriority: normal
nosy: + ezio.melotti
2010-03-24 23:01:57mangus.wahbergcreate