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 how to order Misc/NEWS entries
Type: Stage: resolved
Components: Devguide Versions: Python 3.3
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: chris.jerdonek, eric.araujo, ezio.melotti, ned.deily, python-dev
Priority: normal Keywords: easy, patch

Created on 2012-07-05 23:12 by chris.jerdonek, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
issue-15260-1.patch chris.jerdonek, 2012-07-06 23:59
Messages (5)
msg164704 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-07-05 23:12
I think it would help if the "Commit Messages and NEWS Entries" subsection of the Developer's Guide said something about where in the ordering new Misc/NEWS entries should be added (e.g. at the top or bottom or by importance):

http://docs.python.org/devguide/committing.html?highlight=news#commit-messages-and-news-entries

The only reference I could find was an indirect reference in the section about the Developer Log:

http://docs.python.org/devguide/developers.html
msg164735 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-07-06 16:30
The whole file is ordered with newest on top (newest Python version), so I guess it’s implicit for all committers that sections are also ordered with newest on top.  It does not actually matter; the contents of one “what’s new in Python W.XyZ” are not ordered.

A nice trick to make Mercurial’s automatic file merge work is to put your entry after the first or the first two entries, so that if you commit, then pull new changesets and merge, the merge will success automatically.
msg164762 - (view) Author: Chris Jerdonek (chris.jerdonek) * (Python committer) Date: 2012-07-06 23:59
Patch attached.  I moved the discussion of NEWS entries to a section before the discussion on commit messages because previously, the commit message discussion referenced NEWS entries before they had been discussed (and not vice versa).  This seems clearer to me.

Let me know if I have mischaracterized what is customary, and I can change the wording.
msg164772 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2012-07-07 01:39
New changeset bbe197bf57a1 by Ned Deily in branch 'default':
Issue #15260: Expand information on Misc/NEWS entries.
http://hg.python.org/devguide/rev/bbe197bf57a1
msg164773 - (view) Author: Ned Deily (ned.deily) * (Python committer) Date: 2012-07-07 01:41
Thanks for the patch!
History
Date User Action Args
2022-04-11 14:57:32adminsetgithub: 59465
2012-07-07 01:41:25ned.deilysetstatus: open -> closed

nosy: + ned.deily
messages: + msg164773

resolution: fixed
stage: resolved
2012-07-07 01:39:52python-devsetnosy: + python-dev
messages: + msg164772
2012-07-06 23:59:53chris.jerdoneksetfiles: + issue-15260-1.patch
keywords: + patch
messages: + msg164762
2012-07-06 16:30:08eric.araujosetnosy: + eric.araujo
messages: + msg164735
2012-07-05 23:12:24chris.jerdonekcreate