Clarify class variable documentation on WP_Query

[danielbachhuber]

Most of the PHPDoc begins with "Set if query" (e.g. "Set if query contains posts."). However, each of these variables is set. More correct documentation would be "True if query" or similar.

[DrewAPicture]

More correct documentation would be to actually write summaries for the properties describing what they represent. "True if query" would be useful in the @var description, however.

[megane9988]

Set if query → True if query.

[megane9988]

Can I fix this ticket?

[DrewAPicture]

@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
/**
 * 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.

[megane9988]

@DrewAPicture Thanks for your advice.

I updated patch. I added Doc comment in first and second part.

If it is OK, I continue ather part.

[DrewAPicture]

@megane9988 Looks like a great start, yep!

[megane9988]

update patch

[megane9988]

fix miss comment

[megane9988]

@DrewAPicture I reuploaded patch. Check please.

[DrewAPicture]

In 40966:

Docs: Add more useful summaries to the DocBlocks for boolean $is_* properties in WP_Query.

Props megane9988 for the initial patch.
Fixes #34726.