[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:  tschutter
     Type:  defect (bug)              |      Status:  assigned
 Priority:  normal                    |   Milestone:  4.1
Component:  Users                     |     Version:
 Severity:  normal                    |  Resolution:
 Keywords:  good-first-bug has-patch  |     Focuses:  docs
--------------------------------------+------------------------

Comment (by DrewAPicture):

 OK, here's some feedback on [attachment:29846.diff]:

 * `$meta_compare` – `'meta_value'` in the description should be
 `$meta_value`
 * `$offset` – Offset can be used even without pagination, though it relies
 on `$number` being set, so that should be mentioned. Perhaps "Can be used
 in conjunction with pagination."
 * `$number` – Same as `$offset`, is usable with or without pagination.
 Also, worth mentioning that -1 is not supported.

 Everything else looks pretty good. Once you make these changes, it should
 be ready to go in!

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