[wp-trac] [WordPress Trac] #45462: Changes required in comment of get_file_description() function
WordPress Trac
noreply at wordpress.org
Sun Dec 2 11:47:46 UTC 2018
#45462: Changes required in comment of get_file_description() function
----------------------------+----------------------
Reporter: ramizmanked | Owner: (none)
Type: defect (bug) | Status: closed
Priority: normal | Milestone:
Component: Administration | Version:
Severity: normal | Resolution: invalid
Keywords: has-patch | Focuses: docs
----------------------------+----------------------
Changes (by swissspidy):
* status: new => closed
* focuses: docs, administration => docs
* resolution: => invalid
* version: trunk =>
* milestone: Awaiting Review =>
Comment:
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.
--
Ticket URL: <https://core.trac.wordpress.org/ticket/45462#comment:1>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list