Give it a spin!<div><br></div><div>If it works for you - or especially if it doesn't - I would appreciate any feedback as to why, so that I can continue to improve it.</div><div><br></div><div>Chip<br><br><div class="gmail_quote">
On Tue, Jul 5, 2011 at 9:49 AM, Angelo Bertolli <span dir="ltr"><<a href="mailto:angelo.bertolli@gmail.com">angelo.bertolli@gmail.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex;">
That's interesting. I'll have to take a look. I've been looking for a<br>
really basic/simple WP3 theme that I could use as a basis for making<br>
other themes without having to include every feature.<br>
<div class="im"><br>
<br>
On 07/05/2011 10:47 AM, Chip Bennett wrote:<br>
> Heh, fire away!<br>
><br>
> Oenology is intentionally over-commented (if anything), given that, at<br>
> the end of the day, its underlying purpose is to be a teaching tool.<br>
> That said, while I would probably pare down on the inline documentation<br>
> somewhat if I were optimizing for end-use, I wouldn't cut out all that<br>
> much. I've really grown to appreciate the usefulness of phpDoc.<br>
><br>
> Chip<br>
><br>
> On Tue, Jul 5, 2011 at 9:42 AM, Edward Caissie <<a href="mailto:edward.caissie@gmail.com">edward.caissie@gmail.com</a><br>
</div><div class="im">> <mailto:<a href="mailto:edward.caissie@gmail.com">edward.caissie@gmail.com</a>>> wrote:<br>
><br>
> @Mike -<br>
><br>
> Not to point any fingers or anything (@Chip ... duck); have you had<br>
> a look at the Oenology Theme?<br>
><br>
> Now there is documentation, perhaps not in the same vein as what you<br>
> have in mind but something to consider when looking at a code to<br>
> comment ratio.<br>
><br>
><br>
> Cais.<br>
><br>
> PS: I'm not knocking the documentation of the existing theme or the<br>
> proposed one, I've always believed the better the documentation the<br>
> better the code. EAC.<br>
><br>
><br>
> On Tue, Jul 5, 2011 at 9:46 AM, Michael Fields <<a href="mailto:michael@mfields.org">michael@mfields.org</a><br>
</div><div class="im">> <mailto:<a href="mailto:michael@mfields.org">michael@mfields.org</a>>> wrote:<br>
><br>
> Possibly, but that's a matter of opinion. Personally, I find<br>
> that undocumented code is harder to maintain in the long run. I<br>
> definitely do not agree with that article though as the<br>
> "docblock" style example is a bit over-the-top while the<br>
> function most-likely does not need to be documented. Everything<br>
> in-between is not covered. For me, documentation serves as a<br>
> record of intention. If the words do not match the code, it is<br>
> easier for me or someone else to debug. I love it! You can't<br>
> make me stop :)<br>
><br>
> On Jul 5, 2011, at 6:32 AM, scribu wrote:<br>
><br>
>> Michael, if 50% of the file is made up of comments, then you<br>
>> might be doing something wrong. See:<br>
>><br>
>> <a href="http://www.codinghorror.com/blog/2008/07/coding-without-comments.html" target="_blank">http://www.codinghorror.com/blog/2008/07/coding-without-comments.html</a><br>
>><br>
>> --<br>
</div>>> <a href="http://scribu.net" target="_blank">http://scribu.net</a> <<a href="http://scribu.net/" target="_blank">http://scribu.net/</a>><br>
<div class="im">>> _______________________________________________<br>
>> theme-reviewers mailing list<br>
>> <a href="mailto:theme-reviewers@lists.wordpress.org">theme-reviewers@lists.wordpress.org</a><br>
</div>>> <mailto:<a href="mailto:theme-reviewers@lists.wordpress.org">theme-reviewers@lists.wordpress.org</a>><br>
<div class="im">>> <a href="http://lists.wordpress.org/mailman/listinfo/theme-reviewers" target="_blank">http://lists.wordpress.org/mailman/listinfo/theme-reviewers</a><br>
><br>
><br>
> _______________________________________________<br>
> theme-reviewers mailing list<br>
> <a href="mailto:theme-reviewers@lists.wordpress.org">theme-reviewers@lists.wordpress.org</a><br>
</div>> <mailto:<a href="mailto:theme-reviewers@lists.wordpress.org">theme-reviewers@lists.wordpress.org</a>><br>
<div class="im">> <a href="http://lists.wordpress.org/mailman/listinfo/theme-reviewers" target="_blank">http://lists.wordpress.org/mailman/listinfo/theme-reviewers</a><br>
><br>
><br>
><br>
> _______________________________________________<br>
> theme-reviewers mailing list<br>
> <a href="mailto:theme-reviewers@lists.wordpress.org">theme-reviewers@lists.wordpress.org</a><br>
</div>> <mailto:<a href="mailto:theme-reviewers@lists.wordpress.org">theme-reviewers@lists.wordpress.org</a>><br>
<div><div></div><div class="h5">> <a href="http://lists.wordpress.org/mailman/listinfo/theme-reviewers" target="_blank">http://lists.wordpress.org/mailman/listinfo/theme-reviewers</a><br>
><br>
><br>
><br>
><br>
> _______________________________________________<br>
> theme-reviewers mailing list<br>
> <a href="mailto:theme-reviewers@lists.wordpress.org">theme-reviewers@lists.wordpress.org</a><br>
> <a href="http://lists.wordpress.org/mailman/listinfo/theme-reviewers" target="_blank">http://lists.wordpress.org/mailman/listinfo/theme-reviewers</a><br>
_______________________________________________<br>
theme-reviewers mailing list<br>
<a href="mailto:theme-reviewers@lists.wordpress.org">theme-reviewers@lists.wordpress.org</a><br>
<a href="http://lists.wordpress.org/mailman/listinfo/theme-reviewers" target="_blank">http://lists.wordpress.org/mailman/listinfo/theme-reviewers</a><br>
</div></div></blockquote></div><br></div>