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.

classification
Title: Mention "What's New" in devguide's patch guidelines
Type: enhancement Stage: resolved
Components: Devguide Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: ezio.melotti Nosy List: brett.cannon, ezio.melotti, pitrou, python-dev, tshepang
Priority: normal Keywords: patch

Created on 2013-04-05 01:17 by brett.cannon, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue17637.diff ezio.melotti, 2013-04-10 17:15
issue17637-2.diff ezio.melotti, 2013-04-11 15:18
Messages (11)
msg186060 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2013-04-05 01:17
http://docs.python.org/devguide/patch.html should mention that What's New should also be considered for updating if a change is either significant or requires potential modification of existing code.
msg186082 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2013-04-05 14:11
This is more the duty of the committer IMO.
msg186083 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2013-04-05 14:30
Yes, but that doesn't mean it shouldn't be written down in the devguide (with appropriate note) that committers need to be thinking about this. Start good habits early. =)
msg186088 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2013-04-05 15:37
Then it should probably go in http://docs.python.org/devguide/committing.html
msg186506 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-04-10 15:13
The "What's new" is already mentioned briefly in http://docs.python.org/devguide/committing.html#news-entries.  Would it be enough to rephrase that part and clarify that committers are expected to update it?
Another option is to add a new item to make patchcheck (and to http://docs.python.org/devguide/committing.html#patch-checklist), but I'm not sure it's worth doing it.
msg186512 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2013-04-10 15:53
Yep, I think expanding that would be fine.
msg186521 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-04-10 17:15
Patch attached.
msg186524 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2013-04-10 18:14
"significative" -> "significant"

I would also toss in something like "or not backwards-compatible" so people know they should mention anything that will require code change to stay backwards-compatible.
msg186562 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-04-11 15:18
Patch updated.
msg186563 - (view) Author: Brett Cannon (brett.cannon) * (Python committer) Date: 2013-04-11 15:43
LGTM
msg186564 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2013-04-11 15:48
New changeset 849b2fd4b06a by Ezio Melotti in branch 'default':
#17637: mention "What's New" updating guidelines in the devguide.
http://hg.python.org/devguide/rev/849b2fd4b06a
History
Date User Action Args
2022-04-11 14:57:43adminsetgithub: 61837
2013-04-11 15:50:22ezio.melottisetstatus: open -> closed
resolution: fixed
stage: commit review -> resolved
2013-04-11 15:48:03python-devsetnosy: + python-dev
messages: + msg186564
2013-04-11 15:43:36brett.cannonsetmessages: + msg186563
2013-04-11 15:18:50ezio.melottisetfiles: + issue17637-2.diff
messages: + msg186562

assignee: ezio.melotti
type: enhancement
stage: patch review -> commit review
2013-04-10 18:14:52brett.cannonsetmessages: + msg186524
2013-04-10 17:15:46ezio.melottisetfiles: + issue17637.diff
keywords: + patch
messages: + msg186521

stage: needs patch -> patch review
2013-04-10 15:53:04brett.cannonsetmessages: + msg186512
2013-04-10 15:13:17ezio.melottisetmessages: + msg186506
2013-04-05 21:16:43tshepangsetnosy: + tshepang
2013-04-05 15:37:53pitrousetmessages: + msg186088
2013-04-05 14:30:58brett.cannonsetmessages: + msg186083
2013-04-05 14:11:00pitrousetnosy: + pitrou
messages: + msg186082
2013-04-05 01:17:16brett.cannoncreate