Doc #52181 [Bgs]: Better explanation of function is possible
| From: | macdonald dot richard at gmail dot com | Date: | Fri, 25 Jun 2010 23:15:11 +0000 |
| Subject: | Doc #52181 [Bgs]: Better explanation of function is possible | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-4601@lists.php.net to get a copy of this message | ||
Edit report at http://bugs.php.net/bug.php?id=52181&edit=1
ID: 52181
User updated by: macdonald dot richard at gmail dot com
Reported by: macdonald dot richard at gmail dot com
Summary: Better explanation of function is possible
Status: Bogus
Type: Documentation Problem
Package: Documentation problem
PHP Version: 5.3.2
New Comment:
Well, the response to my initial concern seems to advocate the onus
being on the user to "read a page in its totality" over the manual
containing concise documentation. "the server" may seem like a "pretty
clear reference to the parameter you're passing in" to someone whose
mind works one way and not another but we're all different so why not
make it clearer? It can't hurt. I don't think I'm being pedantic. This
is the first explanation of a PHP function in the manual that I've found
particularly ambiguous. If the description of the function is clear it
shouldn't be necessary to read further into the page. Really, my point
should have been change "the server" to "a server". It does make a
difference to interpretation. Over and out.
Previous Comments:
------------------------------------------------------------------------
[2010-06-25 23:50:23] dtajchreber@php.net
Really? Despite the parameter, the example, and all the other
information on the page, you really thought that? You need to read the
pages in their totality... or at least skim them a little more
thoroughly...
You're also not supplying a HTTP request so that part of your change
doesn't really make sense. 'the server' seems like a pretty clear
reference to the parameter you're passing in.
I say bogus.
------------------------------------------------------------------------
[2010-06-25 09:01:15] macdonald dot richard at gmail dot com
Description:
------------
It would be much clearer if the documentation for this function read
"get_headers â Fetches all the headers sent by a server in response to
a supplied HTTP request" instead of "get_headers â Fetches all the
headers sent by the server in response to a HTTP request" as by saying
"the server" the latter almost implies that the function retrieves the
headers sent by the server that is running the script that includes the
get_headers() function. I assume this is not the case.
------------------------------------------------------------------------
--
Edit this bug report at http://bugs.php.net/bug.php?id=52181&edit=1