WordPress.org
Get WordPress

Make WordPress Core

Opened 6 years ago

Closed 6 years ago

#45462 closed defect (bug) (invalid)

Changes required in comment of get_file_description() function

Reported by: ramizmanked's profile ramizmanked Owned by:
Milestone: Priority: normal
Severity: normal Version:
Component: Administration Keywords: has-patch
Focuses: docs Cc:

Description

There are below two changes required in get_file_description() function comment statement:

  1. Grammar mistake.
  2. Unnecessary space found in function comment.

Attachments (1)

file.php.patch​ (978 bytes) - added by ramizmanked 6 years ago.
File located at /wp-admin/includes/file.php

Download all attachments as: .zip

Change History (2)

@ramizmanked
6 years ago

File located at /wp-admin/includes/file.php

#1 @swissspidy
6 years ago

  • Focuses administration removed
  • Milestone Awaiting Review deleted
  • Resolution set to invalid
  • Status changed from new to closed
  • Version trunk deleted

Hi there and thanks for your patch!

As far as I can tell though, the inline docs look good to me.

The short description just spans two line, so it reads "Get the description for standard WordPress theme files and other various standard WordPress files." which is correct.

Also, the "Appends 'Page Template'" part is aligned with "Description of file from" as it should according to our inline docs standards. See ​https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/php/#1-1-parameters-that-are-arrays for an example.

Note: See TracTickets for help on using tickets.