Doc #74348 [NEW]: just a doc error
| From: | jon at buymydreamhotel dot com | Date: | Fri, 31 Mar 2017 10:01:47 +0000 |
| Subject: | Doc #74348 [NEW]: just a doc error | ||
| Groups: | php.doc.bugs | ||
| Request: | Send a blank email to doc-bugs+get-14560@lists.php.net to get a copy of this message | ||
From: jon at buymydreamhotel dot com
Operating system: win10
PHP version: 5.6.30
Package: Documentation problem
Bug Type: Documentation Problem
Bug description:just a doc error
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 bug report at https://bugs.php.net/bug.php?id=74348&edit=1
--
Try a snapshot (PHP 5.4): https://bugs.php.net/fix.php?id=74348&r=trysnapshot54
Try a snapshot (PHP 5.5): https://bugs.php.net/fix.php?id=74348&r=trysnapshot55
Try a snapshot (trunk): https://bugs.php.net/fix.php?id=74348&r=trysnapshottrunk
Fixed in SVN: https://bugs.php.net/fix.php?id=74348&r=fixed
Fixed in release: https://bugs.php.net/fix.php?id=74348&r=alreadyfixed
Need backtrace: https://bugs.php.net/fix.php?id=74348&r=needtrace
Need Reproduce Script: https://bugs.php.net/fix.php?id=74348&r=needscript
Try newer version: https://bugs.php.net/fix.php?id=74348&r=oldversion
Not developer issue: https://bugs.php.net/fix.php?id=74348&r=support
Expected behavior: https://bugs.php.net/fix.php?id=74348&r=notwrong
Not enough info: https://bugs.php.net/fix.php?id=74348&r=notenoughinfo
Submitted twice: https://bugs.php.net/fix.php?id=74348&r=submittedtwice
register_globals: https://bugs.php.net/fix.php?id=74348&r=globals
PHP 4 support discontinued: https://bugs.php.net/fix.php?id=74348&r=php4
Daylight Savings: https://bugs.php.net/fix.php?id=74348&r=dst
IIS Stability: https://bugs.php.net/fix.php?id=74348&r=isapi
Install GNU Sed: https://bugs.php.net/fix.php?id=74348&r=gnused
Floating point limitations: https://bugs.php.net/fix.php?id=74348&r=float
No Zend Extensions: https://bugs.php.net/fix.php?id=74348&r=nozend
MySQL Configuration Error: https://bugs.php.net/fix.php?id=74348&r=mysqlcfg