php.net |  support |  documentation |  report a bug |  advanced search |  search howto |  statistics |  random bug |  login
Doc Bug #35299 Missing <TT CLASS="constant"> tags in ref.pcre.html
Submitted: 2005-11-20 00:09 UTC Modified: 2005-11-20 16:11 UTC
From: leonard-php-bugzilla at ottolander dot nl Assigned:
Status: Not a bug Package: Documentation problem
PHP Version: Irrelevant OS: irrelevant
Private report: No CVE-ID: None
 [2005-11-20 00:09 UTC] leonard-php-bugzilla at ottolander dot nl
Description:
------------
All but one of the described constants in ref.pcre.html in the online documentation miss a <TT CLASS="constant"> tag.


Patches

Pull Requests

History

AllCommentsChangesGit/SVN commitsRelated reports
 [2005-11-20 00:19 UTC] tony2001@php.net
Please elaborate.

 [2005-11-20 00:37 UTC] leonard-php-bugzilla at ottolander dot nl
I use the online documentation to semi automatically generate the php syntax file for the midnight commander. When comparing the newly generated output with the previous version of the mc php syntax files I noticed some of the PCRE constants were missing. This is caused by the absence of these tags in that particular page.
 [2005-11-20 00:47 UTC] tony2001@php.net
Which exactly are missing ?
 [2005-11-20 01:04 UTC] leonard-php-bugzilla at ottolander dot nl
In table 1 in http://www.php.net/manual/en/ref.pcre.php all the constants in the left column miss these tags. Only the constant mentioned in the right column of the third row is properly tagged. You can compare other pages as well if you need to.
 [2005-11-20 01:24 UTC] tony2001@php.net
From what I can see, there are lots of constants that are documented in such way.
Look for example at http://www.php.net/manual/en/ref.mysql.php and http://www.php.net/manual/en/ref.network.php .

I agree, this is a small incosistency, but this is definitely not a bug, since noone and nowhere told you that all constants will be enclosed with <constant></constant> tag.
 [2005-11-20 01:36 UTC] leonard-php-bugzilla at ottolander dot nl
Well, it would be convenient for such purposes as I described. Indeed I see more inconsistencies: ref.tidy.html is ugly as it tags some pseudo constants but not most of the real ones.

What's the use of the <TT CLASS="constant"> tag in some pages if it's not used consistently and you don't even want to make an effort to implement this consistently? Who maintains these documentation pages anyway? Can I help?

Maybe the consistent use of these tags should be promoted?
 [2005-11-20 01:47 UTC] tony2001@php.net
Of course your help would be appreciated.
Read here: http://www.php.net/manual/en/about.howtohelp.php
and here http://doc.php.net/php/dochowto/ about that.
Yes, I guess it'd be good to have all the docs consistent, so feel free to send your patches to the phpdoc@lists.php.net mailing list.
 [2005-11-20 11:02 UTC] goba@php.net
And Leonard, you will probably also find out that generating your files from the XML sources of the documentation is a much better idea, as it done by the phpedit.net team for example. Look at:

  http://www.waterproof.fr/products/PHPEdit/download.php
  (PHP Functions definition files maker)

It works from our XML sources.

 [2005-11-20 16:09 UTC] leonard-php-bugzilla at ottolander dot nl
I was already wondering what to create patches against. It seems a bit silly to supply patches against the html pages if these pages are generated from another source (XML).

What username 
Wshould I use to do anonymous checkouts? anoncvs, anon, anonymous, nobody, all don't seem to work. Sadly this is not mentioned at http://doc.php.net/php/dochowto/chapter-cvs.php .
 [2005-11-20 16:11 UTC] leonard-php-bugzilla at ottolander dot nl
Please ignore that last remark ;) . That page actually does have a pointer to the anonymous CVS account name.
 
PHP Copyright © 2001-2025 The PHP Group
All rights reserved.
Last updated: Wed Nov 19 14:00:01 2025 UTC