[wp-trac] [WordPress Trac] #30591: Convert nonstandard use of “(optional)” in @param DocBlocks
WordPress Trac
noreply at wordpress.org
Sat Dec 6 21:23:54 UTC 2014
#30591: Convert nonstandard use of “(optional)” in @param DocBlocks
--------------------------+---------------------------
Reporter: coffee2code | Owner: DrewAPicture
Type: defect (bug) | Status: closed
Priority: low | Milestone: 4.1
Component: General | Version:
Severity: normal | Resolution: fixed
Keywords: has-patch | Focuses: docs
--------------------------+---------------------------
Changes (by DrewAPicture):
* owner: => DrewAPicture
* status: new => closed
* resolution: => fixed
Comment:
In [changeset:"30753"]:
{{{
#!CommitTicketReference repository="" revision="30753"
Convert various uses of `(optional)` in core parameter descriptions to use
the style prescribed in the inline documentation standards for PHP.
The style for marking parameters optional in inline PHP docs is: `@param
type $var Optional. Description. Accepts. Default.`, where Accepts can be
omitted on a case-by-case basis.
Props coffee2code.
Fixes #30591.
}}}
--
Ticket URL: <https://core.trac.wordpress.org/ticket/30591#comment:2>
WordPress Trac <https://core.trac.wordpress.org/>
WordPress publishing platform
More information about the wp-trac
mailing list