Doc #78142 [PATCH]: Function prototype return value does not contain type in case of failure

Edit report at https://bugs.php.net/bug.php?id=78142&edit=1 ID: 78142 Patch added by: cmb@php.net Reported by: mail at marcus dot haase dot name Summary: Function prototype return value does not contain type in case of failure Status: Verified Type: Documentation Problem Package: *General Issues Operating System: Irrelevant PHP Version: Irrelevant Assigned To: cmb Block user comment: N Private report: N New Comment: The following pull request has been associated: Patch Name: Fix #78142: Function prototype return value does not contain type in … On GitHub: https://github.com/php/doc-en/pull/155 Patch: https://github.com/php/doc-en/pull/155.patch Previous Comments: ------------------------------------------------------------------------ [2020-10-17 13:32:54] cmb@php.net Update: the current stance is that such issues will be fixed, when proper support for rendering union types[1] is available. [1] <https://github.com/php/phd/pull/30> ------------------------------------------------------------------------ [2019-06-13 08:34:27] mail at marcus dot haase dot name So, the docs will stay wrong, because there are too many errors? I always held the php documentation in high esteem, I hope, this is not goint to change. ------------------------------------------------------------------------ [2019-06-11 14:29:59] girgias@php.net This "issue" has been raised multiple times already and the current stance that I'm aware of is that the doc will not be changed to encompass false as a return value in the prototype. The main reason for this is that there are so many functions affected that it is unpractical. ------------------------------------------------------------------------ [2019-06-11 11:36:55] mail at marcus dot haase dot name Description: ------------ The return type for mb-strpos is declared as int, although it can be either int of false, as is explained in the text of the documentation later on. To somebody reading only the call-description but not the textual description, this is misleading. --- mb_strpos ( string $haystack , string $needle [, int $offset = 0 [, string $encoding = mb_internal_encoding() ]] ) : int --- --- From manual page: https://php.net/function.mb-strpos --- Test script: --------------- Irrelevant Expected result: ---------------- Remove the PHP7.1 return type ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=78142&edit=1