Re: [PEAR-DEV] PEAR CS Documentation Incorrect?
[email protected] (Chuck Burgess)
| Newsgroups | php.pear.dev,php.pear.doc |
|---|---|
| Message-ID | <[email protected]> |
On Mon, Sep 7, 2009 at 2:38 PM, Mark Wiesemann <[email protected]> wrote: > Hannes Magnusson wrote: > >> As you can see by the highlighting, that example is b0rked. >> I assume the documentor was trying to prevent the $Id$ keyword being >> expanded by SVN. >> This _could_ also be a bug in the application rendering the markup >> (PhD)... >> >> Please file this as a documentation bug report :] >> > > The bug report already exists since March: > http://bugs.php.net/bug.php?id=47679 > > Regards, > Mark I took a look at that PHP bug, as well as looking at both the example in the docs and its source in standards.xml. Since both occurrences are examples of usage, should it matter if CVS/SVN expands the $Id$ keyword? If it doesn't, then the example shows you what you should write in your @version tag... if it does, the example shows what a fully expanded @version tag looks like. Either/both are reasonable example content, IMO. If there are no objections to this line of thinking, then I can solve the bug by simply using "$Id$" in those two instances and commit it. Thoughts? -- CRB