<div dir="ltr">I personally find their RST example to be a "jumble" only because the second column isn't aligned. I find the RST style to be easier to read than Napoleon when it's correctly aligned, although admittedly it does take a small amount of effort to keep it aligned. Both are fine options, and I'd be quite happy either way.<div><div><br></div><div>Michael</div></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Mon, Oct 17, 2016 at 11:14 AM, Sean Myers <span dir="ltr"><<a href="mailto:sean.myers@redhat.com" target="_blank">sean.myers@redhat.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">I'd love it if we could stop writing docs in the ":param foo:" style. Instead,<br>
I think that we should use the sphinx extension "napoleon" to write docstrings<br>
that are *way* more human-readable (in my opinion, at least) while still<br>
generating good sphinx docs.<br>
<br>
I think Napoleon's page in the sphinx docs explain this pretty well:<br>
<a href="http://www.sphinx-doc.org/en/stable/ext/napoleon.html" rel="noreferrer" target="_blank">http://www.sphinx-doc.org/en/<wbr>stable/ext/napoleon.html</a><br>
<br>
I've got like three more RFCs queued up; I'm trying to be nice and not overload<br>
pulp-dev with all my crazy ideas simultaneously. :)<br>
<br>
<br>______________________________<wbr>_________________<br>
Pulp-dev mailing list<br>
<a href="mailto:Pulp-dev@redhat.com">Pulp-dev@redhat.com</a><br>
<a href="https://www.redhat.com/mailman/listinfo/pulp-dev" rel="noreferrer" target="_blank">https://www.redhat.com/<wbr>mailman/listinfo/pulp-dev</a><br>
<br></blockquote></div><br></div>