Wrong or misleading descriptive comments in Code (core)

[kixe]

Please correct wrong and misleading comments

PageArray::filterData()
https://github.com/processwire/processwire/blob/4725ece5f86374a8de73d132e54b0ac4c9ae1f09/wire/core/PageArray.php#L391

WRONG: "Filter out Pages that don't match the selector."
RIGHT: "Filter out pages that match or do not match the selector (destructive)"

PageArray::filter()
https://github.com/processwire/processwire/blob/4725ece5f86374a8de73d132e54b0ac4c9ae1f09/wire/core/PageArray.php#L406

WRONG: "Filter out pages that don't match the selector (destructive)"
RIGHT: "Filter out pages that match the selector (destructive)"

[ryancramerdesign]

@kixe I don't understand. The behavior of both filter() and filterData() is to filter out pages that don't match the given selector. Leaving you with just pages that DO match your selector. You are right that filterData() that the function has an option to reverse its behavior, but that is not the default behavior of the function so that is described with the option not the function.

[kixe]

@ryancramerdesign I came across this because the description comment of the two functions not() and filter() is exactly the same. But they don't do the same thing. Maybe there is a language problem on my part understanding what is meant by filtering. Either the return value or what is left behind. It's a matter of perspective. At least the descriptions for not() and filter() should be different. filterData() can do both, depending on how the second argument is set.

[ryancramerdesign]

@kixe I see, yes you are right, the description for the not() method is incorrect. I have pushed a fix for that.