[wp-trac] [WordPress Trac] #51063: Comment description update on class.wp-scripts file

[WordPress Trac]

#51063: Comment description update on class.wp-scripts file
------------------------------+------------------------------
 Reporter:  Laxman Prajapati  |       Owner:  (none)
     Type:  defect (bug)      |      Status:  new
 Priority:  normal            |   Milestone:  Awaiting Review
Component:  Script Loader     |     Version:  5.5
 Severity:  normal            |  Resolution:
 Keywords:  has-patch close   |     Focuses:  docs
------------------------------+------------------------------
Changes (by SergeyBiryukov):

 * keywords:  has-patch good-first-bug => has-patch close
 * component:  General => Script Loader


Comment:

 Hi there, welcome back to WordPress Trac! Thanks for the patch.

 The existing descriptions look fine as is to me:
 * "Name of the script to add the inline script to" is a description of the
 parameter. "Must be lowercase" is a clarification on which values are
 accepted. I don't think these should be combined in a single sentence.
 * Per the [https://developer.wordpress.org/coding-standards/inline-
 documentation-standards/php/#line-wrapping documentation standards],
 DocBlocks should be wrapped to the next line after around 80 characters
 for better readability. There are some functions with complex DocBlocks in
 core where this is not always feasible, in which case they can take up to
 120 characters. But the ones in this file seem fine as is.

 For reference, these DocBlocks were previously adjusted per the
 documentation standards in [47170].

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