[Pulp-dev] RFC: Use Napoleon when Writing Docs

[Michael Hrivnak]

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.

Michael

On Mon, Oct 17, 2016 at 11:14 AM, Sean Myers <sean.myers at redhat.com> wrote:

> I'd love it if we could stop writing docs in the ":param foo:" style.
> Instead,
> I think that we should use the sphinx extension "napoleon" to write
> docstrings
> that are *way* more human-readable (in my opinion, at least) while still
> generating good sphinx docs.
>
> I think Napoleon's page in the sphinx docs explain this pretty well:
> http://www.sphinx-doc.org/en/stable/ext/napoleon.html
>
> I've got like three more RFCs queued up; I'm trying to be nice and not
> overload
> pulp-dev with all my crazy ideas simultaneously. :)
>
>
> _______________________________________________
> Pulp-dev mailing list
> Pulp-dev at redhat.com
> https://www.redhat.com/mailman/listinfo/pulp-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://listman.redhat.com/archives/pulp-dev/attachments/20161017/f9e72c5b/attachment.htm>