[Twisted-Python] Review process, news fragments

James Y Knight foom at fuhm.net
Mon Jun 21 10:12:02 EDT 2010

On Jun 20, 2010, at 6:26 PM, exarkun at twistedmatrix.com wrote:
> Obviously this is English prose we're talking about here, and  
> there's a
> lot of room for variation.  I don't want to impose a *strict* style
> guide here.  I do want the fragments to all aim for roughly the same
> level of detail, and they should all at least make sense to a reader  
> who
> hasn't looked at the history of the relevant ticket.  And where it  
> makes
> sense, I'd like the presentation of the information (like the age of  
> the
> deprecation on an API being removed or changed) to be uniform.

I think the only real way to ensure this is to have a human edit the  
information after it's concatenated together, before release. Having  
pre-written news fragments from all the authors of the changes makes  
that task a lot easier, but I think you really need to see everything  
together in one file and have a single person apply some editorial  
judgement to the result to have it come out well.


More information about the Twisted-Python mailing list