php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #74348 just a doc error
Submitted: 2017-03-31 10:01 UTC Modified: 2017-03-31 10:14 UTC
From: jon at buymydreamhotel dot com Assigned:
Status: Wont fix Package: Filter related
PHP Version: 5.6.30 OS: win10
Private report: No CVE-ID: None
Have you experienced this issue?
Rate the importance of this bug to you:

 [2017-03-31 10:01 UTC] 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 ??? ) 





Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2017-03-31 10:04 UTC] requinix@php.net
-Status: Open +Status: Feedback -Package: Documentation problem +Package: Filter related
 [2017-03-31 10:04 UTC] requinix@php.net
The fourth character in that list is a period so it seems like a moot point to me...
 [2017-03-31 10:14 UTC] peehaa@php.net
-Status: Feedback +Status: Wont fix
 [2017-03-31 10:14 UTC] peehaa@php.net
The full stop is also already in the list of characters in both cases so I don't see how this can be confusing.

Also all sentences in there end with full stops.

As such I don't see it needing fixing.
 
PHP Copyright © 2001-2021 The PHP Group
All rights reserved.
Last updated: Sun Nov 28 19:03:38 2021 UTC