[wp-trac] [WordPress Trac] #34726: Clarify class variable documentation on WP_Query

[WordPress Trac]

#34726: Clarify class variable documentation on WP_Query
----------------------------------------+------------------------------
 Reporter:  danielbachhuber             |       Owner:  megane9988
     Type:  defect (bug)                |      Status:  assigned
 Priority:  normal                      |   Milestone:  Awaiting Review
Component:  Query                       |     Version:
 Severity:  normal                      |  Resolution:
 Keywords:  needs-patch good-first-bug  |     Focuses:  docs
----------------------------------------+------------------------------
Changes (by DrewAPicture):

 * owner:   => megane9988
 * status:  new => assigned


Comment:

 @megane9988 Thanks for the patch.

 Unfortunately what needs to happen here is actually two-fold. The first,
 as I mentioned in comment:1 is that we need to write actual summaries for
 these properties. The second is that whether or not the properties default
 to true should not be in the summary, it should be add as a description
 for the `@var` tags in the property DocBlocks.

 For instance, a valid DocBlock for the `$is_single` property might look
 like this:
 {{{#!php
 <?php
 /**
  * Used to determine whether the current query is for a single post.
  *
  * @since 1.5.0
  * @access public
  * @var bool True if the query is for a single post. Default false.
  */
 public $is_single = false;
 }}}

 Assigning the ticket to mark the good-first-bug as ''claimed''.

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