[wp-trac] [WordPress Trac] #29846: Document default arguments for WP_User_Query::prepare_query()

[WordPress Trac]

#29846: Document default arguments for WP_User_Query::prepare_query()
----------------------------------------+------------------------------
 Reporter:  DrewAPicture                |       Owner:
     Type:  defect (bug)                |      Status:  new
 Priority:  normal                      |   Milestone:  Awaiting Review
Component:  Users                       |     Version:
 Severity:  normal                      |  Resolution:
 Keywords:  needs-patch good-first-bug  |     Focuses:  docs
----------------------------------------+------------------------------
Description changed by DrewAPicture:

Old description:

> The default arguments for
> [https://developer.wordpress.org/reference/classes/wp_user_query/
> WP_User_Query] need to be documented in the
> [https://make.wordpress.org/core/handbook/inline-documentation-standards
> /php-documentation-standards/#1-1-parameters-that-are-arrays hash
> notation] style. The actual docs would go into the docblock for the
> `WP_User_Query::parse_query()` method.
>
> For a good example of documenting default arguments in a hash notation,
> check out the [https://core.trac.wordpress.org/browser/trunk/src/wp-
> includes/query.php#L1446 docs] for `WP_Query::prepare_query()`.
>
> If it helps, you can use the `WP_User_Query`
> [http://codex.wordpress.org/Class_Reference/WP_User_Query Codex article]
> to find more information on the default arguments.
>
> This ticket is reserved for new contributors on the good-first-bug
> keyword.

New description:

 The default arguments for
 [https://developer.wordpress.org/reference/classes/wp_user_query/
 WP_User_Query] need to be documented in the
 [https://make.wordpress.org/core/handbook/inline-documentation-standards
 /php-documentation-standards/#1-1-parameters-that-are-arrays hash
 notation] style. The actual docs would go into the docblock for the
 `WP_User_Query::prepare_query()` method.

 For a good example of documenting default arguments in a hash notation,
 check out the [https://core.trac.wordpress.org/browser/trunk/src/wp-
 includes/query.php#L1446 docs] for `WP_Query::parse_query()`.

 If it helps, you can use the `WP_User_Query`
 [http://codex.wordpress.org/Class_Reference/WP_User_Query Codex article]
 to find more information on the default arguments.

 This ticket is reserved for new contributors on the good-first-bug
 keyword.

--

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