Title: Touch up one-line descriptions of modules for module index
Type: Stage: needs patch
Components: Documentation Versions: Python 3.5
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: angad, brett.cannon, docs@python
Priority: low Keywords: easy, patch

Created on 2014-03-25 16:00 by brett.cannon, last changed 2014-03-27 20:31 by brett.cannon.

File name Uploaded Description Edit
this_module_doc_fix.patch angad, 2014-03-27 20:29 review
Messages (5)
msg214834 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2014-03-25 16:00
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.
msg214979 - (view) Author: Angad Singh (angad) * Date: 2014-03-27 20:10
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?
msg214980 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2014-03-27 20:14
Just the synopsis lines for the modules.
msg214981 - (view) Author: Angad Singh (angad) * Date: 2014-03-27 20:29
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?
msg214982 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2014-03-27 20:31
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.
Date User Action Args
2014-03-27 20:31:18brett.cannonsetmessages: + msg214982
2014-03-27 20:29:18angadsetfiles: + this_module_doc_fix.patch
keywords: + patch
messages: + msg214981
2014-03-27 20:14:22brett.cannonsetmessages: + msg214980
2014-03-27 20:10:08angadsetnosy: + angad
messages: + msg214979
2014-03-25 16:00:11brett.cannoncreate