On 02/04/2015 12:48 PM, Michael Krotscheck wrote:
> I agree. StoryBoard's storyboard-webclient project has a lot of existing
> code already that's pretty well documented, but without knowing what
> documentation system we were going to settle on we never put any rule
> enforcement in place. If someone wants to take a stab at putting together a
> javascript docs build, that project would provide a good test bed that will
> let you test out the tools without having to also make them dance with
> python/sphinx at the same time.
> 
> I.E. I have a bunch of javascript that you can hack on, and the domain
> knowledge of the Infra JS Build tools. I'd be happy to support this effort.

+100

> Michael
> 
> On Wed Feb 04 2015 at 9:09:22 AM Thai Q Tran <tqt...@us.ibm.com> wrote:
> 
>> As we're moving toward Angular, might make sense for us to adopt ngdoc as
>> well.
>>
>> -----Matthew Farina <m...@mattfarina.com> wrote: -----
>> To: "OpenStack Development Mailing List (not for usage questions)" <
>> openstack-dev@lists.openstack.org>
>> From: Matthew Farina <m...@mattfarina.com>
>> Date: 02/04/2015 05:42AM
>> Subject: [openstack-dev] [horizon] JavaScript docs?
>>
>>
>> In python we have a style to document methods, classes, and so forth. But,
>> I don't see any guidance on how JavaScript should be documented. I was
>> looking for something like jsdoc or ngdoc (an extension of jsdoc). Is there
>> any guidance on how JavaScript should be documented?
>>
>> For anyone who doesn't know, Angular uses ngdoc (an extension to the
>> commonly used jsdoc) which is written up at
>> https://github.com/angular/angular.js/wiki/Writing-AngularJS-Documentation
>> .
>> __________________________________________________________________________
>> OpenStack Development Mailing List (not for usage questions)
>> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>> __________________________________________________________________________
>> OpenStack Development Mailing List (not for usage questions)
>> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
>> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
>>
> 
> 
> 
> __________________________________________________________________________
> OpenStack Development Mailing List (not for usage questions)
> Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
> 


__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: openstack-dev-requ...@lists.openstack.org?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev

Reply via email to