Doc #68042 [NEW]: series of missing/inadequate documentation
| From: | jmichae3 at yahoo dot com | Date: | Thu, 18 Sep 2014 11:26:35 +0000 |
| Subject: | Doc #68042 [NEW]: series of missing/inadequate documentation | ||
| Groups: | php.doc.bugs | ||
| Request: | Send a blank email to doc-bugs+get-11486@lists.php.net to get a copy of this message | ||
From: jmichae3 at yahoo dot com
Operating system: win7ult64sp1retail
PHP version: 5.6.0
Package: Documentation problem
Bug Type: Documentation Problem
Bug description:series of missing/inadequate documentation
Description:
------------
This started with a documentation check for a reply I received:
"Your code to test function creation should be
!is_callable(${'is'.$AcctTypes[$i].'file'})"
this does not match what is given in the example in the documentation
(although it works somehow regardless of the example).
see Actual for the list of items that need attention.
Test script:
---------------
1. http://php.net/manual/en/function.is-callable.php
2. search for type hint in search box [no results]
Expected result:
----------------
- clarified documentation for "name" argument in
http://php.net/manual/en/function.is-callable.php
- "type hint" definition in the documentation somewhere I can search
for
- callable listed in right hand side navigatoin sidebar.
Actual result:
--------------
is_callable()'s "name" argument conflicts with its "callable" type in
the documentation at http://php.net/manual/en/function.is-callable.php
does "the callback function to check" mean:
- the function body string
- the lambda function body (this seems more appropriate)
- the name string of the variable containing the function name
- the name of the function
replace name with functionBody? this way people know to expand the
variable name, otherwise, it's confusing and they will put in a string
rather than lambda function body.
this is exacerbated by another lack of definition or proper link for the
linked type "callable" at
http://php.net/manual/en/language.types.callable.php
this links to http://php.net/manual/en/language.types.callable.php
if you notice on the right hand side navigation where it lists types,
"Callable" is not listed as a type.
none of the pages mentioned gives a definition for "type hint" (a new
term for me). I know what a type is, but I don't know how "hint" (with
regards to "type hint") applies to a type or changes it(?) or makes it
different. I don't know what "type hint" means or does or why it's
there.
so I put "type hint" in the search box, and I got "not found" for search
results.
--
Edit bug report at https://bugs.php.net/bug.php?id=68042&edit=1
--
Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=68042&r=trysnapshot54
Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=68042&r=trysnapshot55
Try a snapshot (trunk): https://bugs.php.net/fix.php?id=68042&r=trysnapshottrunk
Fixed in SVN: https://bugs.php.net/fix.php?id=68042&r=fixed
Fixed in release: https://bugs.php.net/fix.php?id=68042&r=alreadyfixed
Need backtrace: https://bugs.php.net/fix.php?id=68042&r=needtrace
Need Reproduce Script: https://bugs.php.net/fix.php?id=68042&r=needscript
Try newer version: https://bugs.php.net/fix.php?id=68042&r=oldversion
Not developer issue: https://bugs.php.net/fix.php?id=68042&r=support
Expected behavior: https://bugs.php.net/fix.php?id=68042&r=notwrong
Not enough info: https://bugs.php.net/fix.php?id=68042&r=notenoughinfo
Submitted twice: https://bugs.php.net/fix.php?id=68042&r=submittedtwice
register_globals: https://bugs.php.net/fix.php?id=68042&r=globals
PHP 4 support discontinued: https://bugs.php.net/fix.php?id=68042&r=php4
Daylight Savings: https://bugs.php.net/fix.php?id=68042&r=dst
IIS Stability: https://bugs.php.net/fix.php?id=68042&r=isapi
Install GNU Sed: https://bugs.php.net/fix.php?id=68042&r=gnused
Floating point limitations: https://bugs.php.net/fix.php?id=68042&r=float
No Zend Extensions: https://bugs.php.net/fix.php?id=68042&r=nozend
MySQL Configuration Error: https://bugs.php.net/fix.php?id=68042&r=mysqlcfg