Open Stack

On 02/05/2015 10:27 AM, Anton Zemlyanov wrote:
> JSDoc (ngdoc) is good thing. It allows to describe files, functions and
> it's parameters, constructors, classes in case of ES6.

As does Sphinx.

> The problem is it tends to diverge with reality. The code is being fixed
> and evolved, but comments are often not updated (who want to do much
> more work)? And JSDoc generated documentation loses the connection to
> reality. 

That is not a problem. We will just reject patches that do such changes
without updating the comments.

-- 
Radomir Dopieralski