[issue18959] Create a "Superseded modules" section in standard library ToC
New submission from Nick Coghlan: As discussed at the language summit earlier this year [1], it isn't alway easy to tell when glancing through the standard library docs which modules are merely hanging around because removing them would break backwards compatibility. However, after reviewing the current ToC, we currently appear to only have two genuinely superseded modules: optparse (superseded by argparse) and imp (superseded by importlib). Other cases where different modules touch on the same area are high level/low level splits (e.g. select vs selectors), or ones where the alternate modules are offering compatibility with different styles of API (e.g. etree vs DOM for XML, getopt vs argparse). In future, asyncore/asynchat will hopefully be superseded by the PEP 3156 code (as "concurrent.events" or similar) and would also be moved under the new heading. Marking as "easy" since the mechanics of the patch should be pretty simple: create a new heading and move the references to optparse and imp from their current locations. [1] http://python-notes.boredomandlaziness.org/en/latest/conferences/pyconus2013... (I thought I had already created a bug for this, but can't find it, so I've created this new one. If I did already create an issue, we can close it as a duplicate and keep this one.) ---------- assignee: docs@python components: Documentation keywords: easy messages: 197154 nosy: docs@python, ncoghlan priority: normal severity: normal stage: needs patch status: open title: Create a "Superseded modules" section in standard library ToC type: enhancement versions: Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18959> _______________________________________
Changes by Hynek Schlawack <hs@ox.cx>: ---------- nosy: +hynek _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18959> _______________________________________
Changes by Ezio Melotti <ezio.melotti@gmail.com>: ---------- nosy: +ezio.melotti _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18959> _______________________________________
Andrei Dorian Duma added the comment: The patch adds a 'Deprecated Modules' heading in the library's ToC and moves 'imp' & 'optparse' to the new entry. ---------- keywords: +patch nosy: +andrei.duma Added file: http://bugs.python.org/file32331/doc_add_a_deprecated_modules_heading.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18959> _______________________________________
Andrei Dorian Duma added the comment: I changed 'Deprecated Modules' into 'Superseded Modules', as indicated by the issue title. ---------- Added file: http://bugs.python.org/file32332/doc_add_a_deprecated_modules_heading2.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18959> _______________________________________
Mark Lawrence added the comment: Would somebody review the attached patch please. ---------- nosy: +BreamoreBoy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18959> _______________________________________
Georg Brandl added the comment: Thanks for the patch. ---------- nosy: +georg.brandl _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18959> _______________________________________
Roundup Robot added the comment: New changeset 7276bc0b0318 by Georg Brandl in branch '3.4': Closes #18959: move optparse and imp to new "superseded modules" chapter https://hg.python.org/cpython/rev/7276bc0b0318 ---------- nosy: +python-dev resolution: -> fixed stage: needs patch -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue18959> _______________________________________
participants (7)
-
Andrei Dorian Duma -
Ezio Melotti -
Georg Brandl -
Hynek Schlawack -
Mark Lawrence -
Nick Coghlan -
Roundup Robot