Doc #64876 [Opn->Csd]: preg_quote is about escaping, not quoting

From: Date: Mon, 24 Jun 2013 23:18:55 +0000
Subject: Doc #64876 [Opn->Csd]: preg_quote is about escaping, not quoting
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-9980@lists.php.net to get a copy of this message
Edit report at https://bugs.php.net/bug.php?id=64876&edit=1

 ID:                 64876
 Updated by:         philip@php.net
 Reported by:        david at grudl dot com
 Summary:            preg_quote is about escaping, not quoting
-Status:             Open
+Status:             Closed
 Type:               Documentation Problem
 Package:            Documentation problem
 PHP Version:        Irrelevant
-Assigned To:        
+Assigned To:        philip
 Block user comment: N
 Private report:     N

 New Comment:

The word "escaped" was added to the return description, but "quote" is fine here

as the function is named preg_quote(). The overall description clarifies the 
behavior of this function.

Thank you for the bug report.


Previous Comments:
------------------------------------------------------------------------
[2013-06-24 23:17:11] philip@php.net

Automatic comment from SVN on behalf of philip
Revision: http://svn.php.net/viewvc/?view=revision&revision=330635
Log: Added the word escaped to help deal with PHP Bug #64876 and added a 'See Also' for
good measure.

------------------------------------------------------------------------
[2013-05-19 13:34:45] cmbecker69 at gmx dot de

IMO the terms "quote"/"quoting" are absolutely fine here.
Cf. <http://en.wikipedia.org/wiki/Quoting_(shell)>.

------------------------------------------------------------------------
[2013-05-18 07:53:44] david at grudl dot com

Description:
------------
There is a wrong description for function preg_quote at http://php.net/manual/en/function.preg-quote.php:

Description:
> preg_quote — Quote regular expression characters

Return value: 
> Returns the quoted string.

Correct description:
> preg_quote — Escapes special characters used by regular expression. Name of this function
> is wrong, it has nothing to do with quoting.

Correct Return value: 
> Returns the escaped string.




------------------------------------------------------------------------



-- 
Edit this bug report at https://bugs.php.net/bug.php?id=64876&edit=1


Thread (3 messages)

« previous php.doc.bugs (#9980) next »