[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
----------------------------------------+-------------------------------

Comment (by birgire):

 Replying to [comment:15 adamsilverstein]:
 > The question mark indicates the field is optional. If the Object is
 optional it can stay.

 Thanks @adamsilverstein, I skimmed through:

 https://make.wordpress.org/core/handbook/best-practices/inline-
 documentation-standards/javascript/

 when I noticed {{{?Object}}} and {{{?number}}}, but I didn't find a
 reference to it there.

 I think it could be helpful to mention it in the Handbook.


 > I don't see a number parameter in that function al all though, seems
 like that line can be removed?

 I wasn't exactly sure regarding that,  so I didn't change that.

 [attachment:35465.7.diff]
 - Removes {{{>}}} from description.
 - Replaces {{{–}}} with {{{-}}} in description.
 - Moves a word up to the line above, in description, for better
 readability.
 - Makes a single alignment.

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