php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #52181 Better explanation of function is possible
Submitted: 2010-06-25 09:01 UTC Modified: 2010-06-26 01:15 UTC
From: macdonald dot richard at gmail dot com Assigned:
Status: Not a bug Package: Documentation problem
PHP Version: 5.3.2 OS:
Private report: No CVE-ID: None
 [2010-06-25 09:01 UTC] 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.


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2010-06-25 23:50 UTC] dtajchreber@php.net
-Status: Open +Status: Bogus
 [2010-06-25 23:50 UTC] 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-26 01:15 UTC] macdonald dot richard at gmail dot com
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.
 
PHP Copyright © 2001-2020 The PHP Group
All rights reserved.
Last updated: Fri Feb 28 17:01:33 2020 UTC