[wp-trac] [WordPress Trac] #43270: JSDoc: wp-admin/js/user-suggest.js

[WordPress Trac]

#43270: JSDoc: wp-admin/js/user-suggest.js
--------------------------------+------------------------------------------
 Reporter:  timhavinga          |       Owner:  atimmer
     Type:  defect (bug)        |      Status:  closed
 Priority:  normal              |   Milestone:  Awaiting Review
Component:  Networks and Sites  |     Version:
 Severity:  normal              |  Resolution:  fixed
 Keywords:                      |     Focuses:  javascript, docs, multisite
--------------------------------+------------------------------------------

Comment (by atimmer):

 Thank you for your contribution!

 About your questions:

 * I've discussed this during the #core-js chat. The takeaway is that
 because this documentation is mainly for people reading the code, the way
 you have documented it is the way to go.
 * The optional data attributes are fairly specific to this use-case, so I
 would say that the way you documented it is great. It is human readable
 and I don't think we need a repeatable way to do this.

 I made a one change before committing:

 * Reformatted the second doc block to have a clear short description and a
 longer description.

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