<div class="gmail_quote">On Sun, Dec 2, 2012 at 6:19 PM, Jeff Allen <span dir="ltr"><<a href="mailto:"ja...py"@farowl.co.uk" target="_blank">"ja...py"@farowl.co.uk</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">

  
    
  
  <div bgcolor="#FFFFFF" text="#000000"><div class="im">
    On 02/12/2012 07:08, Nick Coghlan wrote:
    </div><blockquote type="cite">
      <div class="gmail_quote"><div class="im">On Sun, Dec 2, 2012 at 4:56 PM,
        christian.heimes <span dir="ltr"><<a href="mailto:python-checkins@python.org" target="_blank">python-checkins@python.org</a>></span>
        wrote:<br>
        </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
          <a href="http://hg.python.org/cpython/rev/9af5a2611202" target="_blank">...</a><br>
          diff --git a/Misc/NEWS b/Misc/NEWS<br>
          ...<div class="im"><br>
          +- Issue #16592: stringlib_bytes_join doesn't raise
          MemoryError on allocation<br>
          +  failure.<br>
        </div></blockquote><div class="im">
        <div><br>
          Please don't write NEWS entries in past tense like this -
          they're annoyingly ambiguous, as it isn't clear whether the
          entry is describing the reported problem or the fix for the
          problem. Describing just the new behaviour or the original
          problem and the fix is much easier to follow. For example:<br>
          <br>
            - Issue #16592: stringlib_bytes_join now correctly raises
          MemoryError on allocation failure.<br>
            - Issue #16592: stringlib_bytes_join was triggering
          SystemError on allocation failure. It now correctly raises
          MemoryError.<br>
          <br>
          Issue titles for actual bugs generally don't make good NEWS
          entries, as they're typically a summary of the problem rather
          than the solution (RFE's are different, as there the issue
          title is often a good summary of the proposed change) <br>
          <br>
        </div>
      </div></div>
    </blockquote>
    You mean please do (re-)write such statements in the past tense,
    when the news is that the statement is no longer true. <br>
    <br>
    I agree about the ambiguity that arises here, but there's a simple
    alternative to re-writing. Surely all that has been forgotten here
    is an enclosing "The following issues have been resolved:"? I think
    there's a lot to be said for cut and paste of actual titles on
    grounds of accuracy and speed (and perhaps scriptability).<br></div></blockquote><div><br>Readability matters - ambiguous release notes don't help anyone, and, like code, release notes are read by many more people than write them.<br>
<br>Cheers,<br>Nick. <br></div><div><br></div></div>-- <br>Nick Coghlan   |   <a href="mailto:ncoghlan@gmail.com">ncoghlan@gmail.com</a>   |   Brisbane, Australia<br>