Doc->Req #76547 [Opn->Sus]: Parameters in documentation dynamic search

From: Date: Tue, 18 Sep 2018 10:12:41 +0000
Subject: Doc->Req #76547 [Opn->Sus]: Parameters in documentation dynamic search
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-16002@lists.php.net to get a copy of this message
Edit report at https://bugs.php.net/bug.php?id=76547&edit=1 ID: 76547 Updated by: cmb@php.net Reported by: david at frankieandshadow dot com Summary: Parameters in documentation dynamic search -Status: Open +Status: Suspended -Type: Documentation Problem +Type: Feature/Change Request Package: Documentation problem Operating System: NA PHP Version: Irrelevant Block user comment: N Private report: N New Comment: Certainly not a bug – reclassifying. This information is stored in the localStorage of the browser, which is usually limited to a certain size, and we're already close to 5MB if the search indexes for two languages are stored. Since adding the parameter info might roughly double the amount of data, it doesn't seem to be feasible to add it for now. Suspending this ticket for the time being. I suggest to use an IDE/editor with support for signature help of built-in functions, anyway. Previous Comments: ------------------------------------------------------------------------ [2018-06-29 11:08:49] david at frankieandshadow dot com Description: ------------ It would be really helpful if in the dynamic search in the documentation it didn't just give the function names that match and the short description, but also their parameters, e.g. strpos($haystack, $needle, [$offset=0]) => int Find the position of the first occurrence of a substring in a string Rather than just strpos Find the position of the first occurrence of a substring in a string In maybe 50% of cases, all I need to check is the order of the parameters (especially the search ones, because haystack and needle are so inconsistent in parameter positioning), and with the parameters and maybe the return type I very often wouldn't need to go the the complete page at all. Test script: --------------- n/a ------------------------------------------------------------------------ -- Edit this bug report at https://bugs.php.net/bug.php?id=76547&edit=1

« previous php.doc.bugs (#16002) next »