<div dir="ltr"><div>Hi all,</div><div><br></div><div>Thanks for the PR, Ben. <br></div><div><br></div><div>Note that this is in the numpy-tutorials repo, which is a new repo created to specifically host Jupyter notebook tutorials for NumPy users. It is still not in its final form.</div><div><br></div><div>One of the questions around this PR is where this style guide should live: in the main documentation or in the numpy-tutorials repo? <br></div><div><br></div><div>If you have thoughts on this, please share.<br></div><div><br></div><div>Best,</div><div><br></div><div>- Melissa<br></div></div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Mon, Jun 22, 2020 at 3:44 PM Ben Nathanson <<a href="mailto:numpy_gsod@bigriver.xyz">numpy_gsod@bigriver.xyz</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">I've submitted PR #11 in the new numpy-tutorials repo<br>
(<a href="https://github.com/numpy/numpy-tutorials/pull/11" rel="noreferrer" target="_blank">https://github.com/numpy/numpy-tutorials/pull/11</a>) to provide a<br>
checklist and standard style for writing tutorials.<br>
<br>
Added tutorial content is an objective of NEP 44. We're expecting part<br>
of the content to come from new contributors (for instance, through<br>
Ryan Cooper's generous offer to get his students involved,<br>
<a href="https://mail.python.org/pipermail/numpy-discussion/2020-May/080715.htmll" rel="noreferrer" target="_blank">https://mail.python.org/pipermail/numpy-discussion/2020-May/080715.htmll</a>).<br>
The PR will provide a guide for all contributors to work from.<br>
<br>
While "tutorial" is often used broadly for introductory material, here<br>
it is closely defined: a multistep participatory walkthrough for a<br>
user new to NumPy.<br>
<br>
This is the meaning of "tutorial" in NEP 44; it was originally<br>
distinguished from other kinds of documentation by Daniele Procida<br>
(<a href="https://documentation.divio.com/tutorials/" rel="noreferrer" target="_blank">https://documentation.divio.com/tutorials/</a>).<br>
<br>
One goal of the PR, in fact, is to make sure the tutorial stays a<br>
tutorial and doesn't mission-creep into other kinds of introductory<br>
documentation. Procida's insight is that mission creep like this leads<br>
to failed docs.<br>
<br>
At today's docs meeting it was suggested that the PR be announced on<br>
the mailing list for possible further comment.<br>
_______________________________________________<br>
NumPy-Discussion mailing list<br>
<a href="mailto:NumPy-Discussion@python.org" target="_blank">NumPy-Discussion@python.org</a><br>
<a href="https://mail.python.org/mailman/listinfo/numpy-discussion" rel="noreferrer" target="_blank">https://mail.python.org/mailman/listinfo/numpy-discussion</a><br>
</blockquote></div>