Doc #68042 [Opn->Nab]: series of missing/inadequate documentation
| From: | krakjoe@php.net | Date: | Sun, 21 Sep 2014 06:24:21 +0000 |
| Subject: | Doc #68042 [Opn->Nab]: series of missing/inadequate documentation | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-11488@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=68042&edit=1
ID: 68042
Updated by: krakjoe@php.net
Reported by: jmichae3 at yahoo dot com
Summary: series of missing/inadequate documentation
-Status: Open
+Status: Not a bug
Type: Documentation Problem
Package: Documentation problem
Operating System: win7ult64sp1retail
PHP Version: 5.6.0
Block user comment: N
Private report: N
New Comment:
Your problem stems from misunderstanding, not a bug in the documentation.
Previous Comments:
------------------------------------------------------------------------
[2014-09-18 11:26:34] jmichae3 at yahoo dot com
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 this bug report at https://bugs.php.net/bug.php?id=68042&edit=1