Doc #74348 [Opn->Fbk]: just a doc error
| From: | requinix@php.net | Date: | Fri, 31 Mar 2017 10:04:19 +0000 |
| Subject: | Doc #74348 [Opn->Fbk]: just a doc error | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-14561@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=74348&edit=1
ID: 74348
Updated by: requinix@php.net
Reported by: jon at buymydreamhotel dot com
Summary: just a doc error
-Status: Open
+Status: Feedback
Type: Documentation Problem
-Package: Documentation problem
+Package: Filter related
Operating System: win10
PHP Version: 5.6.30
Block user comment: N
Private report: N
New Comment:
The fourth character in that list is a period so it seems like a moot point to me...
Previous Comments:
------------------------------------------------------------------------
[2017-03-31 10:01:27] jon at buymydreamhotel dot com
Description:
------------
http://php.net/manual/en/filter.filters.sanitize.php
Doc Error - Probably General
You do not appear to have a convention for delimiting chars included for instance as a list of chars
that will be removed by a santisation (EN spelling) routine and the punctuation that is actually
included in the surrounding sentence.
This could mislead.
================= Start Quote =====================
Remove all characters except letters, digits and
$-_.+!*'(),{}|\\^~[]`<>#%";/?:@&=.
================= End Quote ===================
The other sentences in this page are terminated by full stops.
Should the reader interpret the trailing full stop as part of the filter set or as simply the
termination of that sentence? It seems to be ambiguous without further knowledge.
I know the answer but someone less experienced might be mislead.
Its not as pedantic as it seems - someone really could goof up big time if they decided to take the
knowledge implied in the doc and apply it elsewhere.
( secondly why I am asked to supply a patch name and receive completely irrelevant screens showing
me supposedly matched previously reported bugs when its a simple DOC bug and those
'matches' have nothing to do with the issue. Please consider separating out simple doc
bugs from the main form here as it is a bit ridiculous to present the well meaning passerby with all
hoops they have to jump through just to report a simple doc bug - your doc talks of making the
developer want to fix the bug but equally you could consider making the external developer feel
motivated to report the issue in the first place - quid quo pro ??? )
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=74348&edit=1