[issue21063] Touch up one-line descriptions of modules for module index
New submission from Brett Cannon: E.g. linecache says "This module provides random access to individual lines from text files." That's a big awkward and could just drop "This module" to read more easily. ---------- assignee: docs@python components: Documentation keywords: easy messages: 214834 nosy: brett.cannon, docs@python priority: low severity: normal stage: needs patch status: open title: Touch up one-line descriptions of modules for module index versions: Python 3.5 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21063> _______________________________________
Angad Singh added the comment: Interested in taking this up as my first patch - @brett - are you only talking about the :synopsis: or the occurrence of "This module" at the beginning of the description as well? -angad ---------- nosy: +angad _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21063> _______________________________________
Brett Cannon added the comment: Just the synopsis lines for the modules. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21063> _______________________________________
Angad Singh added the comment: Not a lot of occurrences if I only look at the synopsis. Attaching a diff. Also saw a weird "This subpackage" in apiref.rst line 1767. Fix that too? ---------- keywords: +patch Added file: http://bugs.python.org/file34639/this_module_doc_fix.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21063> _______________________________________
Brett Cannon added the comment: Sure, if you are just looking for "This module" you won't find very many instances. The bug is more about doing a sweep through *every* module's synopsis and just cleaning them up to read better. The "this module" instance for linecache is just an example of why a cleanup would be good to do. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue21063> _______________________________________
Change by Sanchit Khurana <sanchitkhuranask@gmail.com>: ---------- pull_requests: +16848 stage: needs patch -> patch review pull_request: https://github.com/python/cpython/pull/17363 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21063> _______________________________________
Brett Cannon <brett@python.org> added the comment: New changeset f8a6316778faff3991144c3aec4fa92d7b30a72b by Brett Cannon (Sanchit Khurana) in branch 'master': bpo-21063: Improve module synopsis for distutils (GH-17363) https://github.com/python/cpython/commit/f8a6316778faff3991144c3aec4fa92d7b3... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21063> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +16863 pull_request: https://github.com/python/cpython/pull/17381 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21063> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +16864 pull_request: https://github.com/python/cpython/pull/17382 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21063> _______________________________________
Change by Brett Cannon <brett@python.org>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21063> _______________________________________
Change by miss-islington <mariatta.wijaya+miss-islington@gmail.com>: ---------- pull_requests: +16865 pull_request: https://github.com/python/cpython/pull/17383 _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21063> _______________________________________
miss-islington <mariatta.wijaya+miss-islington@gmail.com> added the comment: New changeset 089387ed1f47d9443b5f28bb1863294eeac2de08 by Miss Islington (bot) in branch '3.8': bpo-21063: Improve module synopsis for distutils (GH-17363) https://github.com/python/cpython/commit/089387ed1f47d9443b5f28bb1863294eeac... ---------- nosy: +miss-islington _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21063> _______________________________________
Brett Cannon <brett@python.org> added the comment: New changeset 2f2489310d89f589a091aa09ac1eb973d9a383d8 by Brett Cannon (Miss Islington (bot)) in branch '3.7': bpo-21063: Improve module synopsis for distutils (GH-17363) (#17381) https://github.com/python/cpython/commit/2f2489310d89f589a091aa09ac1eb973d9a... ---------- _______________________________________ Python tracker <report@bugs.python.org> <https://bugs.python.org/issue21063> _______________________________________
participants (4)
-
Angad Singh -
Brett Cannon
-
miss-islington
-
Sanchit Khurana