Newsgroups: php.internals
Path: news.php.net
Xref: news.php.net php.internals:35418
Mailing-List: contact internals-help@lists.php.net; run by ezmlm
Received-SPF: pass (pb1.pair.com: domain gmail.com designates 64.233.170.184 as permitted sender)
DomainKey-Status: bad
DomainKey-Signature: a=rsa-sha1; c=nofws;
        d=gmail.com; s=gamma;
        h=message-id:date:from:to:subject:mime-version:content-type:content-transfer-encoding:content-disposition;
        b=I3XXuSZxfDD/jdUpz/E5u6sm6EmEvqidspyYqiHhR/GdNG/0lXJ/UNPDQw/AP3MXIQM9f0JsGY8juPc5yOPkAFuqCLw/3ruYGCrxbloDBNQPayUGV/bq3w3fQ6AeuVrKW9/rpp5N/4aQ6K66ry1qdCeyuBZqc9cDXGoEn++XjbE=
Message-ID: <7f3ed2c30802121022q204eabf1wc6277765ceaaf469@mail.gmail.com>
Date: Tue, 12 Feb 2008 19:22:39 +0100
To: "Dmitry Stogov" <dmitry@php.net>, 
	"PHP Development" <internals@lists.php.net>
MIME-Version: 1.0
Content-Type: text/plain; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit
Content-Disposition: inline
Subject: Re: [ZEND-ENGINE-CVS] cvs: ZendEngine2(PHP_5_3) / zend_compile.c zend_highlight.c zend_language_parser.y zend_language_scanner.l /tests heredoc_001.phpt heredoc_002.phpt heredoc_003.phpt heredoc_004.phpt heredoc_005.phpt heredoc_006.phpt heredoc_007.
From: hannes.magnusson@gmail.com ("Hannes Magnusson")

I would really really really really appreciate if the [DOC] tag was used more.

While only random new features (or whatever requiring docs) are tagged
with [DOC] it is totally useless as the doc team still has to browse
through every single commit to figure out if there is something in it
to document.

To make matters worse; some new optional parameters/functions/whatever
are disguised as bug reports with absurd summary and when they get
fixed only "Fixed bug#xxx (foobar)" is added to the commit message and
NEWS file... you really expect the doc team to actually _read_  the
_commit_ and ignoring the commit message?

Undocumented features are useless to the "general public". And no,
your blog and/or article on/in devzone/php|arch is definitely not the
place to write documentations if you want the feature to be used.

On a related note: When reclassifying bug reports as "documentation
problem" *please* mention what exactly it is that needs to be
documented!

Common guys, we can do a lot better here.

-Hannes

On Feb 12, 2008 10:27 AM, Dmitry Stogov <dmitry@php.net> wrote:
> dmitry          Tue Feb 12 09:27:46 2008 UTC
>
>   Added files:                 (Branch: PHP_5_3)
>     /ZendEngine2/tests  heredoc_001.phpt heredoc_002.phpt
>                         heredoc_003.phpt heredoc_004.phpt
>                         heredoc_005.phpt heredoc_006.phpt
>                         heredoc_007.phpt heredoc_008.phpt
>                         heredoc_009.phpt heredoc_010.phpt
>                         heredoc_011.phpt nowdoc.inc nowdoc_001.phpt
>                         nowdoc_002.phpt nowdoc_003.phpt nowdoc_004.phpt
>                         nowdoc_005.phpt nowdoc_006.phpt nowdoc_007.phpt
>                         nowdoc_008.phpt nowdoc_009.phpt nowdoc_010.phpt
>                         nowdoc_011.phpt nowdoc_012.phpt nowdoc_013.phpt
>                         nowdoc_014.phpt nowdoc_015.phpt
>
>   Modified files:
>     /php-src    NEWS
>     /ZendEngine2        zend_compile.c zend_highlight.c zend_language_parser.y
>                         zend_language_scanner.l
>   Log:
>   Added NEWDOC
>
>
> --
> Zend Engine CVS Mailing List (http://cvs.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
>