Open Stack

On 02/04/2015 06:06 PM, Thai Q Tran wrote:
> As we're moving toward Angular, might make sense for us to adopt ngdoc
> as well.

I don't think it makes much sense. We don't have any style guide for the
JavaScript documentation simply because it's not needed. We don't really
have any for Python either (although there might be a lot of
python-specific stuff in what we have). We just have guidelines for
documenting code. Any code. JavaScript, Python, even templates.

Plus, the documentation generator that we are using already, Sphinx,
supports JavaScript perfectly fine, so I see no reason to add another tool.

I agree it would be nice to actually start using it for JavaScript code
too, though.

-- 
Radomir Dopieralski