<div dir="ltr"><div>I don't think this should be an issue - towncrier just reflows .rst fragments in individual files into a complete list when it's run. Worst case, it is possible to edit the final changelog file that is generated before pushing it.</div><div><br></div><div>Thinking about this a bit, maybe it would be better anyway (from a maintainability and discoverability point of view) to have examples showing off new features get a new examples gallery entry instead of a plot directive snippet on the what's new page.</div><div><br></div><div>David<br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Wed, 10 Jul 2019 at 07:35, Thomas Caswell <<a href="mailto:tcaswell@gmail.com" target="_blank">tcaswell@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr">I think this is a great idea, however I am a bit concerned about "should contain a single sentence or paragraph describing the change".  Does this mean we can not include plot directives it the what_new?<div><br></div><div>Tom</div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, Jun 25, 2019 at 1:45 PM David Stansby <<a href="mailto:dstansby@gmail.com" target="_blank">dstansby@gmail.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex"><div dir="ltr"><div>Dear all,</div><div><br></div><div>I am proposing to change up how Matplotlib's API changes/what's new pages are generated, in particular moving to using <a href="https://github.com/hawkowl/towncrier" target="_blank">towncrier</a> to add more automation to the process. This is motivated by the crazy amount of time it took me to combine all the API change and what's new fragments into a coherent page for the 3.1.0 release.</div><div><br></div><div>The PR to change this process is here: <a href="https://github.com/matplotlib/matplotlib/pull/14589" target="_blank">https://github.com/matplotlib/matplotlib/pull/14589</a> The new process would be</div><div><ul><li>When a new feature or api change or code removal is implemented, add a changelog file to the <i>changelog/</i> folder</li><li>The changelog file should be named <PR number>.<type>.rst, and should contain a single sentence or paragraph describing the change. <type> is the type of change, ie. api_change, new_feature or removal<br></li><li>towncrier can then automatically collate these fragments into a single .rst page, which can be manually edited if needed before releasing</li></ul><div>I think this will significnatly reduce the burden of producing what's new pages each release, without adding any extra burden on those writing the what's new entries.<br></div><div><br></div><div>Please take a look at the PR and leave comments/questions/suggestions! In particular, feedback on what "types" of changelog entry to include would be very welcome.</div><div><br></div><div>All the best,</div><div>David<br></div><div><br></div><div><br></div></div></div>
_______________________________________________<br>
Matplotlib-devel mailing list<br>
<a href="mailto:Matplotlib-devel@python.org" target="_blank">Matplotlib-devel@python.org</a><br>
<a href="https://mail.python.org/mailman/listinfo/matplotlib-devel" rel="noreferrer" target="_blank">https://mail.python.org/mailman/listinfo/matplotlib-devel</a><br>
</blockquote></div><br clear="all"><div><br></div>-- <br><div dir="ltr" class="gmail-m_3078871095048688409gmail-m_-1538000493353106200gmail_signature">Thomas Caswell<br><a href="mailto:tcaswell@gmail.com" target="_blank">tcaswell@gmail.com</a></div>
</blockquote></div>