[wp-trac] [WordPress Trac] #41682: JSDoc correction for namespaces

WordPress Trac noreply at wordpress.org
Wed Aug 23 12:54:10 UTC 2017


#41682: JSDoc correction for namespaces
--------------------------+-------------------------------
 Reporter:  herregroen    |       Owner:  adamsilverstein
     Type:  defect (bug)  |      Status:  assigned
 Priority:  normal        |   Milestone:  4.9
Component:  General       |     Version:
 Severity:  normal        |  Resolution:
 Keywords:  has-patch     |     Focuses:  javascript, docs
--------------------------+-------------------------------

Comment (by adamsilverstein):

 @herregroen I reviewed your patch and have a few questions:

 * do the `@lends` statements need to be inserted inline like that (and not
 in the doc block above)? Makes for really long lines and more difficult to
 read
 * In a few spots you have removed existing inline comments. Are these
 changes related? can we remove them to keep this patch focused solely on
 the namespace changes?
 * are parse errors expected when run locally? i did `npm install` and
 `grunt jsdoc` and although many files parsed fine, I also got a bunch of:
 `ERROR: Unable to parse a tag's type expression for source file`

--
Ticket URL: <https://core.trac.wordpress.org/ticket/41682#comment:12>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform


More information about the wp-trac mailing list