On Jan 5, 2007, at 10:40 AM, Veloz wrote:
Thanks for your reply to this topic, John.
I probably should have not brought up 1.2 at all, as it throws my
comments into a special case of a "development" release, and we all
expect "less" from a development release.
In any event my nit is less about The Manual that it is with lack of
comments in the code itself.
My suggestions apply for 1.x code as well. I spent several days going
over some 1.x code a while back, and there was not a stitch of helpful
comments in there anywhere.
I would imagine that this is at least a slight exaggeration, as the
online API has been generated from inline documentation code blocks.
I realize your frustration though, and it something we're working on.
One nice example of commenting is inside the core.php file, which
describes all the options, some noteworthy side effects, and so on. In
other words, it gives insight, which is what we all want and need.
I am not dissing anyone for their efforts on Cake because of lack of
good commenting and documentation, but I am saying that it ultimately
makes the product less valuable to people who want to use it.. and
that's too bad considering the effort that has gone into it.
I agree - we'll redouble our efforts, and I hope you can see we agree
with you. I hope you can also see how strapped we are for resources
and help as well.
I would love to help out with the commenting of the code, but I must
first become an expert at parts of the system on my own because the
current code does nothing to get you up to speed with what you are
looking at :-)
... Which makes you a perfect candidate for the job. Often times I
write something that new people can't understand, because I assume
too much. New eyes on the project is never a problem for us. Let me
know if you'd like to contribute, and we can work out a solution that
works well for both of us. We have people that criticize the project
all day long. What we really need is people that are willing to jump
in and help us make it better in a focused, managed way.
No one is under-qualified, as there's plenty of work to be done. :)
Might I ask you some questions at some point, about the system?
Anytime - that's what this mailing list/group is for, and you can
usually find me on our IRC channel[1].
Thanks,
John
[1] - _psychic_ in #cakephp @ irc.freenode.net
--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups "Cake
PHP" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at
http://groups.google.com/group/cake-php?hl=en
-~----------~----~----~----~------~----~------~--~---
