[issue11710] Landing pages in docs for standard library packages

New submission from Nick Coghlan <ncoghlan@gmail.com>: http://docs.python.org/py3k/urllib errors out rather than returning an index page for the modules that are part of the urllib package. This index page could also link to the HOWTO at http://docs.python.org/py3k/howto/urllib2.html The following packages have the same problem: xml, http, xmlrpc, concurrent These ones look OK: logging, curses, html, tkinter These index pages don't necessarily need to be linked from the contents page, but they should exist so that manually typed URLs for these packages do something useful rather than erroring out with a 404. ---------- assignee: docs@python components: Documentation messages: 132481 nosy: docs@python, ncoghlan priority: normal severity: normal status: open title: Landing pages in docs for standard library packages versions: Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________

Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________

Éric Araujo <merwok@netwok.org> added the comment: It works with docs.python.org/py3k/library/urllib ---------- nosy: +eric.araujo _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________

Nick Coghlan <ncoghlan@gmail.com> added the comment: That link goes to a 404 error page for me. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________

Éric Araujo <merwok@netwok.org> added the comment: Okay, now I understand your request: a spam package should have a page at library/spam in addition to submodules pages. +1. ---------- versions: +Python 2.7, Python 3.1 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________

Nick Coghlan <ncoghlan@gmail.com> added the comment: Oh, I see the confusion - yeah, the missing "library" in the URL in my first post was just a typo. It was actually present in my test URLs (otherwise the 4 packages with landing pages wouldn't have worked). The problem in 2.7 is smaller, since there aren't as a many packages - only xml and xmlrpc are missing landing pages in that version. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________

Ezio Melotti <ezio.melotti@gmail.com> added the comment: The packages without a landing page on 3.2 are: concurrent xml urllib http xmlrpc In the concurrent case the problem could be solved with redirects too, since there's only one module in the package. The other modules could provide a landing page that lists the modules in the package. (Note that the html page only lists html.escape, so the other modules could be added there too.) ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________

Changes by Senthil Kumaran <senthil@uthcode.com>: ---------- nosy: +orsenthil _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________

Changes by Raymond Hettinger <raymond.hettinger@gmail.com>: ---------- assignee: docs@python -> georg.brandl nosy: +georg.brandl _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________

Roundup Robot added the comment: New changeset 1141648fa655 by Georg Brandl in branch '3.3': Closes #11710: create "landing pages" (/library/package.html) for those packages that have no documented content themselves, e.g. "urllib" or "http". http://hg.python.org/cpython/rev/1141648fa655 ---------- nosy: +python-dev resolution: -> fixed stage: -> committed/rejected status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11710> _______________________________________
participants (6)
-
Ezio Melotti
-
Nick Coghlan
-
Raymond Hettinger
-
Roundup Robot
-
Senthil Kumaran
-
Éric Araujo