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

[Brian Bouterse]

Also +1. Is this story ready to be groomed and marked as a sprint
candidate=yes?

https://pulp.plan.io/issues/2347


On Wed, Oct 26, 2016 at 5:07 PM, Jeff Ortel <jortel at redhat.com> wrote:

> +1 switching to Napoleon.
>
> On 10/17/2016 10:14 AM, Sean Myers 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
> >
>
>
> _______________________________________________
> 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/20161027/b96cbc71/attachment.htm>