Where is the documentation? [#517112]

You claim in the theme's description that the goal of this project is to have well documented and well commented source code - yet this project currently has neither. In fact I have not been able to find *ANY* documentation whatsoever, not even a readme text file in the download package. The only source code comments are for grouping css classes and identifying closing div tags in the tpl files.

Not that any of this is a bad thing - but you are making strong claims in the project description that say otherwise. If this is any indication of the integrity of the maintainers then I'll make a point to stay far away from this theme.

Comments

Comment #2

Rob_Feature CreditAttribution: Rob_Feature commented 13 July 2009 at 12:00

A couple of thoughts as a follow-up to your issue (then I'll mark it pending to wait for a response).

First, let me just suggest that the best part about open source and free projects like Drupal and it's contrib. modules/themes is that if you don't like what's there and/or it doesn't meet your needs...you haven't lost anything. Just don't use what you don't like. If this theme doesn't have what you're looking for, feel free to look elsewhere. (complaining to the person who put time in to create it isn't helpful and rarely gets things changed to meet your needs)

Second, I believe that the code is pretty well documented (through comments) throughout the markup. What you're referring to is outside documentation (readme.txt etc), which very few themes have. The reason? What would go in there? It's not like there's a bunch you can explain about a theme (ie. it's not very complex, especially this one). If markup is documented and you can read html/css then there is no need for anything further.

I'd be interested in what documentation you'd expect from a simple theme like this one...

What we say in the description is: "standards-compliant and well documented." I believe this is both...if you want something beyond this, you can request a feature, but please be more specific and try not to insult us in the process (it doesn't make me want to help you).

Comment #3

Rob_Feature CreditAttribution: Rob_Feature commented 13 July 2009 at 12:15

Status:

Active

» Postponed (maintainer needs more info)

Status change...

Comment #4

livingegg CreditAttribution: livingegg commented 18 August 2009 at 21:45

Hi thanks for replying.

You also say this in the description: "We've commented everything to death and made sure it all, basically, would make sense to everyone."

Really? How about making sense to someone who is not already a drupal theming expert?

The fact is that your source code is barely commented at all. Do you really want examples? Okay...

page.tpl.php - I have extracted every comment from this file and shown below:

</div>  <!-- END LOGO -->
</div> <!-- END NAV -->
</div> <!-- END WRAPPER -->
</div> <!--END HEADER SECTION-->
</div> <!--END LEFT SIDEBAR-->
</div><!--END BODY-SECTION-->
</div> <!-- END CONTENT-REGION -->
</div> <!--END FOOTER-->

Commented to death? - Well, I guess that depends on your interpretation. The page.tpl.php in Garland has a ton more comments than this. For example - it contains a comment block which explains what all those variables are - WOW!!

How about style.css?

/* Theme Created By Mustardseed Media Inc.  
Need help customizing?  Drop us a line!  http://mustardseedmedia.com
*/
/* GLOBAL RESETS  */
/*LINK STYLES*/
/* HEADING STYLES */
/*MAIN PAGE LAYOUT */
/* PRIMARY LINKS */
/* SECONDARY LINKS */
/* SITE WIDE STUFF */
/* TABS */
/* BLOCKS */
/* COMMENTS */
/* PAGERS */
/* USER LOGIN FORM */

Commented to death eh? Well once again I guess that depends on your interpretation.

How about node.tpl.php or block.tpl.php? Well those files contain no comments - not even a header mentioning WHAT IT IS.

There... I have just posted every bit of commentation and documentation contained in your ENTIRE PROJECT! Commented to death?? I guess that depends on your interpretation.

My interpretation is that you are completely full of poo-poo.

Cheers.