[python-committers] what's going on with Misc/NEWS?

[Brett Cannon]

On Fri, May 24, 2013 at 4:18 PM, R. David Murray <rdmurray at bitdance.com> wrote:
> On Fri, 24 May 2013 15:26:29 -0400, Brett Cannon <brett at python.org> wrote:
>> On Fri, May 24, 2013 at 2:27 PM, Antoine Pitrou <solipsis at pitrou.net> wrote:
>> > Le vendredi 24 mai 2013 à 14:23 -0400, Brett Cannon a écrit :
>> >> > You'll have to copy stuff by hand, though, if you don't want to rely on the
>> >> > merge machinery. So we have two possible file layouts:
>> >> >
>> >> > * (current) a single Misc/NEWS is merged from branch to branch. Pro: hg merge
>> >> > copies the text for you. Con: hg merge sometimes screws up and you have to
>> >> > clean up a large conflict.
>> >>
>> >> But hg won't let you simply revert;
>> >
>> > hg rev -r <branch name> Misc/NEWS
>>
>> I'll add that to the devguide if it works for me next time.
>
> I find that I also have to do:
>
>     hg resolve -m Misc/NEWS
>
> which I find to be a really obnoxious mis-feature of hg.
>
>> > Do you mean Mics/NEWS doc typos?
>>
>> No I mean typos in the docs. For instance, I found a missing
>> parenthesis in the docs for some module, but backporting it is enough
>> of a pain that I don't want to bother. The only reason I did this one
>> for sys is because it clarified semantics.
>
> You're adding a NEWS entry for a single character doc typo?  No wonder
> you don't like making doc fixes :)
>
> I only make news entries for doc changes when they are major or are
> changes to the doc *system*.

It's an extreme example, but for instance I added an entry for this
sys.modules change where I just added a clarifying sentence. Probably
not needed but wanted to make sure that people got the message they
shouldn't replace sys.modules.