php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #64581 documentation of regexp is difficult to read
Submitted: 2013-04-04 13:44 UTC Modified: 2016-06-07 18:24 UTC
From: 2e60ed46bf928d2c at courier8 dot hu Assigned: cmb (profile)
Status: Not a bug Package: PCRE related
PHP Version: 5.4.13 OS:
Private report: No CVE-ID: None
 [2013-04-04 13:44 UTC] 2e60ed46bf928d2c at courier8 dot hu
Description:
------------
http://www.php.net/manual/en/regexp.reference.delimiters.php

documentation of regexp is difficult to read:
 - it is separated to several pages. there is no way to search.
 - it is very long, there are irrelevant paragraphs.
 - i did not found a simple syntax diagram.

i have to read thousands and thousands letters each day.
please keep documentation short and simple!

i recently came across php. i do not like it. its badly designed. its documentation is very complex, difficult to read (it is the indication of bad design), difficult to code. the language itself is full of exceptions, unnecessary constructions. it is awful.


Patches

Add a Patch

Pull Requests

Add a Pull Request

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2013-04-19 10:03 UTC] phpmpan at mpan dot pl
I believe PHP documentation is a place to document PHP, not a tutorial for using regular expressions. Regex syntax or usage has nothing to do with PHP itself. The documentation seems targeted to people who already know regular expressions and focus on how to apply their knowledge to particular regex implementation, as implementations differ slightly between each other.

However, I think that the documentation may be improved by adding some sort of topics list with short descriptions. People may not know all the names ("anchor", "delimiter" etc.) if they were learning regex by practice.
 [2013-08-14 14:16 UTC] yannick@php.net
-Package: Online Doc Editor problem +Package: Documentation problem
 [2016-06-07 18:24 UTC] cmb@php.net
-Status: Open +Status: Not a bug -Package: Documentation problem +Package: PCRE related -Assigned To: +Assigned To: cmb
 [2016-06-07 18:24 UTC] cmb@php.net
> documentation of regexp is difficult to read:
> - it is separated to several pages. there is no way to search.
> - it is very long, there are irrelevant paragraphs.
> - i did not found a simple syntax diagram.

That is so because PCRE is a very complex (and powerful) library,
and even more so due to its evolving nature (what has to be
documented as well). See also the page "How to find more
information about PHP"[1].

Patches and *concrete* hints to improve the documentation are
welcome (see <http://doc.php.net/tutorial/joining.php>). It is,
however, not really useful to state that the documentation (or a
complete chapter for that matter) is generally bad; that is too
subjective (I've heard otherwise, anyway).

[1] <http://php.net/manual/en/about.more.php>
 
PHP Copyright © 2001-2024 The PHP Group
All rights reserved.
Last updated: Fri May 03 05:01:29 2024 UTC