Doc #64581 [Com]: documentation of regexp is difficult to read
| From: | phpmpan at mpan dot pl | Date: | Fri, 19 Apr 2013 10:03:54 +0000 |
| Subject: | Doc #64581 [Com]: documentation of regexp is difficult to read | ||
| References: | 1 | Groups: | php.doc.bugs |
| Request: | Send a blank email to doc-bugs+get-9747@lists.php.net to get a copy of this message | ||
Edit report at https://bugs.php.net/bug.php?id=64581&edit=1
ID: 64581
Comment by: phpmpan at mpan dot pl
Reported by: 2e60ed46bf928d2c at courier8 dot hu
Summary: documentation of regexp is difficult to read
Status: Open
Type: Documentation Problem
Package: Online Doc Editor problem
PHP Version: 5.4.13
Block user comment: N
Private report: N
New Comment:
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.
Previous Comments:
------------------------------------------------------------------------
[2013-04-04 13:44:22] 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.
------------------------------------------------------------------------
--
Edit this bug report at https://bugs.php.net/bug.php?id=64581&edit=1