➜
This issue tracker has been migrated to GitHub,
and is currently read-only.
For more information,
see the GitHub FAQs in the Python's Developer Guide.
Created on 2014-09-11 12:31 by serhiy.storchaka, last changed 2022-04-11 14:58 by admin. This issue is now closed.
| Files | ||||
|---|---|---|---|---|
| File name | Uploaded | Description | Edit | |
| doc_contributed_by_style.patch | serhiy.storchaka, 2014-09-11 12:31 | review | ||
| Messages (7) | |||
|---|---|---|---|
| msg226767 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) *  |
Date: 2014-09-11 12:31 | |
Here is a patch which converts "Contributed by" notes in whatsnews to most prevalent style. This means: * Previous sentence ends by a period and the "Contributed" is titled. * The note ends by a period and it is placed before closing parent. * The note is separated from previous sentence by two spaces or newline (as any sentences). Overwhelming majority of "Contributed by" notes are written in this style (except of unfinished 3.5 whatsnews). |
|||
| msg226850 - (view) | Author: Terry J. Reedy (terry.reedy) * |
Date: 2014-09-12 23:04 | |
I agree with making a complete and separate sentence. There are 3 variations. -- Add parenthetical note after last sentence. (Contributed by me.) -- Add note on next line after short line. (Contributed by me. -- Add note after a blank line. (Contributed by me.) -- I guess version 2 will be formatted the same as version 1. In 3.4 What's New I only say one instance of the 3rd, blank line style, for the multi-paragraph Improvements to Codec Handling, which it arguable was appropriate. |
|||
| msg226853 - (view) | Author: R. David Murray (r.david.murray) * |
Date: 2014-09-13 13:39 | |
Yep, that's exactly the logic I used for "trailing parenthetical sentence" versus "trailing parenthetical paragraph": whether or not what was being referenced was a single paragraph for a block of paragraphs. I went through and made 3.4 consistent, so there should be no changes there. Likewise the editors of earlier whats new should have made those consistent, and it is probably best not to second guess the editor absent a glaring typo. If you want to make 3.5 "currently consistent" by all means do so. However, a final edit pass (or passes) will be needed at release time whatever you do now. |
|||
| msg226854 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) * |
Date: 2014-09-13 16:05 | |
If don't make these editions now, inconsistent lines will provoke inconsistency in future additions. |
|||
| msg230492 - (view) | Author: Ezio Melotti (ezio.melotti) * |
Date: 2014-11-02 15:37 | |
Patch LGTM. |
|||
| msg230507 - (view) | Author: Roundup Robot (python-dev)  |
Date: 2014-11-02 17:29 | |
New changeset e3825486da53 by Serhiy Storchaka in branch '3.4': Issue #22388: Unified the style of "Contributed by" sentences in What's New. https://hg.python.org/cpython/rev/e3825486da53 New changeset 5f10a4a1e4df by Serhiy Storchaka in branch 'default': Issue #22388: Unified the style of "Contributed by" sentences in What's New. https://hg.python.org/cpython/rev/5f10a4a1e4df |
|||
| msg230508 - (view) | Author: Serhiy Storchaka (serhiy.storchaka) * |
Date: 2014-11-02 17:31 | |
Thank you Ezio for your review. |
|||
| History | |||
|---|---|---|---|
| Date | User | Action | Args |
| 2022-04-11 14:58:07 | admin | set | github: 66582 |
| 2014-11-02 17:32:16 | serhiy.storchaka | set | status: open -> closed assignee: docs@python -> serhiy.storchaka resolution: fixed stage: patch review -> resolved |
| 2014-11-02 17:31:29 | serhiy.storchaka | set | messages: + msg230508 |
| 2014-11-02 17:29:34 | python-dev | set | nosy:
+ python-dev messages: + msg230507 |
| 2014-11-02 15:37:59 | ezio.melotti | set | nosy:
+ ezio.melotti messages: + msg230492 |
| 2014-09-13 16:05:07 | serhiy.storchaka | set | messages: + msg226854 |
| 2014-09-13 13:39:39 | r.david.murray | set | messages: + msg226853 |
| 2014-09-12 23:04:53 | terry.reedy | set | nosy:
+ terry.reedy messages: + msg226850 |
| 2014-09-11 12:31:15 | serhiy.storchaka | create | |