[drupal-docs] Venting - do not read

[judah]

Running the contributed modules through phpdoc would be helpful but they 
are less document then the core modules. Contributed modules needs some 
standard requirements for comments like, "You can never have too many 
comments". I was studying the profile module and there was just a lot of 
places where things weren't explained.

I know others have picked it up easily but I haven't been able to. I 
just heard that drupal generates it's sql statements by using regular 
expressions. Huh? Where do I learn about this? Also, how do I debug the 
modules? How do I print out a variable? I would love a something on how 
to debug and add changes to a specific page. Something like, "So you 
want to add a feature to a module" tutorial. Or a, "So you want to help 
debug an error message" tutorial.
In fact that's what I was trying to do when things became so 
frustrating. I wanted to add a new checkbox field show up on the profile 
edit page. I opened the profile module, looked for the function that 
created the options for the page but didn't know where to begin or how 
to trace out a value.

Maybe I just need some support questions answered but a guide would be 
better. Thanks for listening.

Best Regards,
Judah

puregin wrote:

>Hi Judah - are you concerned mainly with core code, or contributed code?
>
>There was a discussion some time about about putting contributed code 
>through PHPDoc and displaying the results on drupaldocs.org, as the 
>core module code is.   I think this would be a good start.
>
>What kind of documentation would best fit your needs and learning style?
>
>Djun
>
>
>
>On 11 Jun 2005, at 9:12 PM, judah wrote:
>  
>


-- 
re·gard
 1. To look at attentively; observe closely.
 2. To look upon or consider in a particular way.
 3. To hold in esteem or respect: She regards her teachers highly.
 4. To relate or refer to; concern: This item regards their liability. 

best
 1. Surpassing all others in excellence, achievement, or quality; most excellent: the best performer; the best grade of ore.
 2. Most satisfactory, suitable, or useful; most desirable: the best solution; the best time for planting.
 3. Greatest; most: He spoke for the best part of an hour.
 4. Most highly skilled: the best doctor in town.