php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Request #76547 Parameters in documentation dynamic search
Submitted: 2018-06-29 11:08 UTC Modified: 2018-09-18 10:12 UTC
From: david at frankieandshadow dot com Assigned:
Status: Suspended Package: Documentation problem
PHP Version: Irrelevant OS: NA
Private report: No CVE-ID: None
Have you experienced this issue?
Rate the importance of this bug to you:

 [2018-06-29 11:08 UTC] 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


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2018-09-18 10:12 UTC] cmb@php.net
-Status: Open +Status: Suspended -Type: Documentation Problem +Type: Feature/Change Request
 [2018-09-18 10:12 UTC] cmb@php.net
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.
 
PHP Copyright © 2001-2018 The PHP Group
All rights reserved.
Last updated: Mon Oct 15 08:01:25 2018 UTC