Bug #3585

Pkg description: what versions beautified??

Details

Request #3585	Pkg description: what versions beautified??
Submitted	2005-02-24 21:35 UTC
From	epte at ruffdogs dot com
Status	Closed
Package	PHP_Beautifier
PHP Version	Irrelevant
OS	Linux
Roadmaps	(Not assigned)

Comments

[2005-02-24 21:35 UTC] epte at ruffdogs dot com

Description:
------------
The description of this package mentions that it is written in PHP5, but says nothing about which versions of PHP can be beautified with it.

[2005-02-25 15:12 UTC] epte at ruffdogs dot com

Yes, and I did later find that piece of documentation only because we do PHP5 work and I hadn't ruled out the possibility of using this package. But the main points are these:

1) the description is misleading. If I hadn't read it closely I might have thought that PHP_Beautifier only beautifies PHP5 code.

2) With so many PEAR packages out there only written for PHP4 or PHP5, I want to know at the description level whether a PEAR package is applicable to the project I'm working on.

Incidentally, in the docs, I would hope for more information, such as, "What versions of PHP can I beautify?" Just saying "you can
beautify script written for PHP 4 and PHP 5, without any
problem" makes me wonder:
1) Have they tested it for various versions of PHP4 and PHP5 or are they just guessing? Is it that the algorithms involved are supposed to be general enough that they don't feel like they have to test it?
2) What about PHP3? (not that I use PHP3, but the question remains)

[2005-02-25 15:15 UTC] epte at ruffdogs dot com

The point is not whether the documentation exists, but it needs to exist on the browse-package level, IMHO.

[2005-02-25 16:06 UTC] clbustos at dotgeek dot org

Ok, you're rigth. I put the info in package level.
About the questions, I answer they in order:
1) Have they tested it for various versions of PHP4 and PHP5 or are they just guessing? Is it that the algorithms involved are supposed to be general enough that they don't feel like they have to test it?

I use the beautifier for the source code of the beautifier itself and for a project, on PHP4, of 20.000-30.000 lines of code, without any problem.
More than this, the package contains some test for the basic functions and the resolution of every bug that I find or was reported. Ergo, is very safe to use.
The algorithm is based on the tokenizer of php, so is very hard to make mistakes.

2) What about PHP3? (not that I use PHP3, but the question remains)

I don't know... probably works.