[wp-trac] [WordPress Trac] #35465: Improve wp.Backbone docs

[WordPress Trac]

#35465: Improve wp.Backbone docs
----------------------------------------+-------------------------------
 Reporter:  ericlewis                   |       Owner:  gma992
     Type:  enhancement                 |      Status:  reopened
 Priority:  normal                      |   Milestone:  5.0
Component:  General                     |     Version:  3.5
 Severity:  normal                      |  Resolution:
 Keywords:  good-first-bug needs-patch  |     Focuses:  javascript, docs
----------------------------------------+-------------------------------
Changes (by birgire):

 * status:  closed => reopened
 * resolution:  fixed =>


Comment:

 [attachment:35465.6.diff] is a suggestion that:

 - Aligns related descriptions.
 - Adds full stops to some summaries.
 - Capitalizes {{{object}}} in  {{{* @param {array|object}}}}
 - Changes a two line {{{//}}} comment into a multiline comment using
 {{{/*...*/}}}.
 - Changes {{{$returns}}} to {{{$return}}}.

 Notes:

 - I noticed further {{{{?Object}}}} and
 {{{{?number}}}}[https://github.com/WordPress/WordPress/blob/bb8d67e6ead6430260c8a595a180074ce410f50e
 /wp-includes/js/wp-backbone.js#L360 here]. Should we remove the question
 marks?

 - Are the {{{>}}} and {{{–}}} really needed
 [https://github.com/WordPress/WordPress/blob/bb8d67e6ead6430260c8a595a180074ce410f50e
 /wp-includes/js/wp-backbone.js#L80 here]?

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