Created on 2014-03-25 16:00 by brett.cannon, last changed 2019-11-26 20:02 by brett.cannon. This issue is now closed.
| Files | ||||
|---|---|---|---|---|
| File name | Uploaded | Description | Edit | |
| this_module_doc_fix.patch | angad, 2014-03-27 20:29 | review | ||
| Pull Requests | |||
|---|---|---|---|
| URL | Status | Linked | Edit |
| PR 17363 | merged | GeniusLearner, 2019-11-23 11:06 | |
| PR 17381 | merged | miss-islington, 2019-11-25 22:18 | |
| PR 17382 | closed | miss-islington, 2019-11-25 22:18 | |
| PR 17383 | merged | miss-islington, 2019-11-25 22:19 | |
| Messages (8) | |||
|---|---|---|---|
| msg214834 - (view) | Author: Brett Cannon (brett.cannon) *  |
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? -angad |
|||
| msg214980 - (view) | Author: Brett Cannon (brett.cannon) * |
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) * |
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. |
|||
| msg357462 - (view) | Author: Brett Cannon (brett.cannon) * |
Date: 2019-11-25 22:18 | |
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/f8a6316778faff3991144c3aec4fa92d7b30a72b |
|||
| msg357463 - (view) | Author: miss-islington (miss-islington) | Date: 2019-11-25 22:26 | |
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/089387ed1f47d9443b5f28bb1863294eeac2de08 |
|||
| msg357528 - (view) | Author: Brett Cannon (brett.cannon) * |
Date: 2019-11-26 20:02 | |
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/2f2489310d89f589a091aa09ac1eb973d9a383d8 |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2019-11-26 20:02:31 | brett.cannon | set | messages: + msg357528 |
| 2019-11-25 22:26:47 | miss-islington | set | nosy:
+ miss-islington messages: + msg357463 |
| 2019-11-25 22:19:50 | miss-islington | set | pull_requests: + pull_request16865 |
| 2019-11-25 22:18:29 | brett.cannon | set | status: open -> closed resolution: fixed stage: patch review -> resolved |
| 2019-11-25 22:18:22 | miss-islington | set | pull_requests: + pull_request16864 |
| 2019-11-25 22:18:15 | miss-islington | set | pull_requests: + pull_request16863 |
| 2019-11-25 22:18:12 | brett.cannon | set | messages: + msg357462 |
| 2019-11-23 11:06:51 | GeniusLearner | set | stage: needs patch -> patch review pull_requests: + pull_request16848 |
| 2014-03-27 20:31:18 | brett.cannon | set | messages: + msg214982 |
| 2014-03-27 20:29:18 | angad | set | files:
+ this_module_doc_fix.patch keywords: + patch messages: + msg214981 |
| 2014-03-27 20:14:22 | brett.cannon | set | messages: + msg214980 |
| 2014-03-27 20:10:08 | angad | set | nosy:
+ angad messages: + msg214979 |
| 2014-03-25 16:00:11 | brett.cannon | create | |