wordpoints icon indicating copy to clipboard operation
wordpoints copied to clipboard

Improved JS inline Docs

Open JDGrimes opened this issue 11 years ago • 6 comments

WordPress is adopting JSDoc, so should we.

JDGrimes avatar Nov 08 '14 22:11 JDGrimes

This is something that we might want to tackle as we improve our JS. I might punt it for now.

JDGrimes avatar Jan 06 '15 21:01 JDGrimes

This is something that we should do as we go along. Closing as maybelater.

JDGrimes avatar Jun 06 '15 21:06 JDGrimes

Looking at our JS while working on some recent tickets, I think that we should go ahead and make an effort to do this one release. The sooner it is done the better, as it becomes more difficult to determine version numbers as time passes.

JDGrimes avatar Sep 29 '16 21:09 JDGrimes

The sooner it is done the better, as it becomes more difficult to determine version numbers as time passes.

For this reason, I think that we should go ahead and at least ad the version numbers, even if some things have to be filled out more later.

The reason that we haven't done more on this already is that I am not familiar enough with JSDoc, and WordPress's standards are kind of vague and not up-to-date. But let's just do our best, if we have to modify things later, at least the main stuff will be in place and changes will be systematic.

JDGrimes avatar Mar 14 '17 14:03 JDGrimes

The JSDocs in core are getting some love now: https://core.trac.wordpress.org/changeset/41351

JDGrimes avatar Sep 09 '17 12:09 JDGrimes

Related: #42901

All summary tags should be removed from existing JSDoc.

JDGrimes avatar Dec 30 '17 19:12 JDGrimes