[openstack-dev] [horizon] JavaScript docs?

Matthew Farina matt at mattfarina.com
Thu Feb 5 18:19:39 UTC 2015


Ah, I had forgotten about the python module documentation. Sorry about that
and thanks for pointing it out.

Can we have that system parse and use JSDoc? I'd like it to be useful to
both JS devs and the doc generation toolchain.

On Thu, Feb 5, 2015 at 9:42 AM, Jeremy Stanley <fungi at yuggoth.org> wrote:

> On 2015-02-05 09:20:35 -0800 (-0800), Matthew Farina wrote:
> [...]
> > But, why do we document methods, classes, or functions in python?
> > Should we drop that and rely on Sphinx? I don't think anyone would
> > argue for that.
> [...]
>
> Particularly since Sphinx collects the method/class/function
> docstrings from the source code to assemble them into
> documentation[1]. I see that as its primary reason for existing in
> fact. Why do you seem to think those choices are at odds with one
> another?
>
> [1] http://docs.openstack.org/developer/nova/api/nova.api.validator.html
> --
> Jeremy Stanley
>
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: OpenStack-dev-request at lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20150205/3dc5f512/attachment.html>


More information about the OpenStack-dev mailing list