Closed (fixed)
Project:
Search API
Version:
7.x-1.x-dev
Component:
Documentation
Priority:
Normal
Category:
Task
Assigned:
Issue tags:
Reporter:
Created:
9 Nov 2015 at 13:26 UTC
Updated:
25 Dec 2015 at 15:44 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #2
rakesh.gectcrComment #3
thepanz commentedThere is a
* @return truein your patch, shouldn't it report Bool instead?Comment #4
rakesh.gectcrIt is returning only, TRUE. There is no false involved in it.
Comment #5
thepanz commentedRight, but "True" is not a valid data type.
see: http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutoria...
Comment #6
rakesh.gectcrbool?Comment #7
thepanz commentedYes,
boolis the right data type to use.If there are cases when the function does not return, you'd should add
nullComment #8
drunken monkeyWow, great work, thanks a lot!
I had a few corrections and further improvements, still, but all in all this is a great step forward, thanks!
Please see my revised patch. Unless you find some issues with it, I can commit it shortly.
Wrong, the Drupal coding standards explicitly state that
trueshould be used in this case.(Although the return value is pretty pointless in such a case anyways and should probably be removed.)
However, in this case it was still wrong, since the methods can also return
FALSE, it was just not documented very well. (For a short time I unfortunately was a bit in love with using "iff".)Comment #9
rakesh.gectcrLooks fine for me.
Comment #11
drunken monkeyGreat to hear.
Committed.
Thanks again for your work here!