WordPress.org

Make WordPress Core

#51063 closed defect (bug) (wontfix)

Comment description update on class.wp-scripts file

Reported by: Laxman Prajapati Owned by:
Milestone: Priority: normal
Severity: normal Version: 5.5
Component: Script Loader Keywords: has-patch
Focuses: docs Cc:

Description

Some comments description updates.

Attachments (1)

51063.patch (1.9 KB) - added by Laxman Prajapati 13 months ago.
Created patch.

Download all attachments as: .zip

Change History (5)

@Laxman Prajapati
13 months ago

Created patch.

#1 @Laxman Prajapati
13 months ago

  • Keywords has-patch good-first-bug added

#2 @SergeyBiryukov
13 months ago

  • Component changed from General to Script Loader
  • Keywords close added; good-first-bug removed

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 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].

#3 @Laxman Prajapati
13 months ago

Okay. Noworry.
Also any update on the ticket #51014 ?

Thanks,
Laxman P.

Version 0, edited 13 months ago by Laxman Prajapati (next)

#4 @desrosj
13 months ago

  • Keywords close removed
  • Milestone Awaiting Review deleted
  • Resolution set to wontfix
  • Status changed from new to closed

Closing this one out as it seems nothing needs updating here.

Please try to keep comments about other tickets on those respective tickets.

Note: See TracTickets for help on using tickets.