Doc #62762 [Wfx]: Incorrect/unnecessary verbage
| From: | tom at happyalienproductions dot com | Date: | Thu, 09 Aug 2012 23:51:12 +0000 |
| Subject: | Doc #62762 [Wfx]: Incorrect/unnecessary verbage | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-8720@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=62762&edit=1
ID: 62762
User updated by: tom at happyalienproductions dot com
Reported by: tom at happyalienproductions dot com
Summary: Incorrect/unnecessary verbage
Status: Wont fix
Type: Documentation Problem
Package: Filesystem function related
Operating System: Windows 7
PHP Version: 5.3.15
Block user comment: N
Private report: N
New Comment:
Yes, I understand the usage of that particular word. That word, in and of itself
is not the issue. The primary issue is that the phrase
"This is a dummy manual entry to satisfy those people who are looking for
unlink() or unset() in the wrong place."
is unnecessarily condescending, as though your are speaking to an annoying
sibling or co-worker. The secondary, and perhaps most important issue is that it
is simply technically incorrect: one need not "look in the wrong place" for this
term, one simply types the word 'delete' into the search field on the PHP
documentation web page and this entry is presented TO them.
The word 'delete' is a perfectly reasonable word to search for in a programming
language reference. If it is not a valid term for the reference being searched,
then display a message notifying the searcher of that fact. Do not assume that
you have determined the "true meaning" of their inquiry, produce a result, and
then proceed to tell them that THEY have looked in the WRONG place!
Previous Comments:
------------------------------------------------------------------------
[2012-08-07 01:20:10] aharvey@php.net
I believe you've misinterpreted the use of the word "dummy" here: it's in the
adjective meaning of "placeholder", not the vaguely insulting noun form.
------------------------------------------------------------------------
[2012-08-06 20:36:52] tom at happyalienproductions dot com
Description:
------------
---
From manual page: http://www.php.net/function.delete#refsect1-function.delete-description
---
This documentation entry has wording that could be considered judegemental and/or insulting. It is
unnecessary to state the the entry for delete is a 'dummy' entry to 'satisfy'
those looking the 'wrong' place. The wording for this entry is very condescending and has
no place in technical documentation.
A simple statement that the page has been redirected from another is all that is needed. A good
example of how this kind of thing should be done can be found at Wikipedia.com.
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=62762&edit=1