<div dir="ltr">We definitely need package-level documentation in any new package.  And ideally, people who know existing packages without documentation would occasionally spend some time documenting them as well.  At least with documentation, you have a chance of understanding what a package is all about... this is useful both for understanding the code and understanding if new code should be put in that package.<div><br></div><div>I would hope people always write package docs when writing new packages, but it's good to explicitly state that it is required.</div></div><br><div class="gmail_quote"><div dir="ltr">On Wed, Aug 26, 2015 at 9:32 AM William Reade <<a href="mailto:william.reade@canonical.com">william.reade@canonical.com</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div class="gmail_extra"><div class="gmail_quote">On Wed, Aug 26, 2015 at 3:11 PM, Frank Mueller <span dir="ltr"><<a href="mailto:frank.mueller@canonical.com" target="_blank">frank.mueller@canonical.com</a>></span> wrote:<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div>So, what do you think?<br></div></div></blockquote><div><br></div></div></div></div><div dir="ltr"><div class="gmail_extra"><div class="gmail_quote"><div>I think it's a good idea :-). I wouldn't want to mandate immediate introduction everywhere, but I think it's reasonable to require it for new code, and for non-trivial changes to older code. Not sure that's quite so cleanly automatable -- more of a review checklist thing, perhaps? (e.g. I'd consider package moves to be "trivial", but reviewboard (for example) doesn't handle them well at all.)</div><div><br></div><div>Cheers</div></div></div></div><div dir="ltr"><div class="gmail_extra"><div class="gmail_quote"><div>William</div></div></div></div><div dir="ltr"><div class="gmail_extra"><div class="gmail_quote"><div> </div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex"><div dir="ltr"><div><br></div>mue<span><font color="#888888"><br><br></font></span></div><span><font color="#888888"><div dir="ltr">-- <br></div><div dir="ltr">Frank Mueller <frank.mueller<a>@canonical.com</a>><br>
Juju Core Sapphire Team <<a>http://jujucharms.com</a>></div>
</font></span><br>--<br>
Juju-dev mailing list<br>
<a href="mailto:Juju-dev@lists.ubuntu.com" target="_blank">Juju-dev@lists.ubuntu.com</a><br>
Modify settings or unsubscribe at: <a href="https://lists.ubuntu.com/mailman/listinfo/juju-dev" rel="noreferrer" target="_blank">https://lists.ubuntu.com/mailman/listinfo/juju-dev</a><br>
<br></blockquote></div></div></div>
--<br>
Juju-dev mailing list<br>
<a href="mailto:Juju-dev@lists.ubuntu.com" target="_blank">Juju-dev@lists.ubuntu.com</a><br>
Modify settings or unsubscribe at: <a href="https://lists.ubuntu.com/mailman/listinfo/juju-dev" rel="noreferrer" target="_blank">https://lists.ubuntu.com/mailman/listinfo/juju-dev</a><br>
</blockquote></div>