<div dir="ltr"><div>There's no question it would be a benefit to others providing support to themes and that is why I like the idea ... and I cannot see why it wouldn't be a benefit even to the theme author when providing assistance with a possible theme issue. The rub is it's not currently a standard in WordPress core (at least not that I am aware of) and I would much prefer supporting an initiative that was reflected in core as a guideline than pushing for something that core may adopt differently in the (near?) future.<br>
<br></div><div>Although some sorts of documentation and annotations are clearly and easily defined and in many cases should be REQUIRED, given there is a certain amount of "poetic license" with inline comments (and some really geeky jokes if you look long enough) that I would be happy to push for a recommended approach (and not ever push for a higher significance) to keep those Easter eggs in code written by those Theme authors that also have a flair for creative writing.<br>
</div><div><br></div>Let's just say I'm taking a "wait and see" approach and as such would only support this idea as the prerogative of the reviewer and not a recommendation of the guidelines ... and I definitely would love to read feedback from others as well.<br>
</div><div class="gmail_extra"><br clear="all"><div>Edward Caissie<br>aka Cais.</div>
<br><br><div class="gmail_quote">On Sat, Feb 2, 2013 at 4:29 PM, Aaron Nimocks <span dir="ltr"><<a href="mailto:aaron_nimocks@yahoo.com" target="_blank">aaron_nimocks@yahoo.com</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div><div style="font-size:12pt;font-family:tahoma,new york,times,serif">I see your point on it and not sure if it should be mandatory either. But since we do support the free themes on the support forums it would make it easier to do so. Was just a thought. :)<br>
<br>Any other feedback?<br><br>Aaron<br><div><span><br></span></div><div><br></div> <div style="font-family:tahoma,new york,times,serif;font-size:12pt"> <div style="font-family:times new roman,new york,times,serif;font-size:12pt">
<div dir="ltr"> <font face="Arial"> <hr size="1"> <b><span style="font-weight:bold">From:</span></b> Edward Caissie <<a href="mailto:edward.caissie@gmail.com" target="_blank">edward.caissie@gmail.com</a>><br> <b><span style="font-weight:bold">To:</span></b> WP Theme Reviewers Mailing List <<a href="mailto:theme-reviewers@lists.wordpress.org" target="_blank">theme-reviewers@lists.wordpress.org</a>> <br>
<b><span style="font-weight:bold">Sent:</span></b> Saturday, February 2, 2013 1:12 PM<br> <b><span style="font-weight:bold">Subject:</span></b> Re: [theme-reviewers] Rule Addition?<br> </font> </div><div><div class="h5">
<br>
<div><div dir="ltr"><div><div>I could see this as a recommendation and to a certain extent I am making it a personal coding standard to at least add code block termination comments throughout my most newest theme project (and will likely refactor my existing projects in a similar fashion).<br>
<br></div>I do not see this currently as being a required "standard" although I would be happy to re-visit the idea more thoroughly once the "Make" WordPress Inline Documentation guidelines are written and published for general use. I would also suggest putting this idea forward for potential inclusion with that "handbook" group.<br>
<br></div>As it is, I support the idea but not as a requirement and only as a reviewer's personal recommendation (and there is a difference between that and a RECOMMENDED review item).<br></div><div>
<br clear="all"><div>Edward Caissie<br>aka Cais.</div>
<br><br><div>On Sat, Feb 2, 2013 at 9:12 AM, Aaron Nimocks <span dir="ltr"><<a rel="nofollow" href="mailto:aaron_nimocks@yahoo.com" target="_blank">aaron_nimocks@yahoo.com</a>></span> wrote:<br><blockquote style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
<div><div style="font-size:12pt;font-family:tahoma,new york,times,serif"><div>I haven't gave this complete thought yet but I would assume this has been brought up before so just wanted to know if it has or why we don't do this.</div>
<div><br></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">From a support or even end user perspective I would absolutely love if each template file was required to have a comment for when it started and ended. This way just viewing the source you can instantly tell which file it is in. I really don't think it would require too much effort for theme submitters but I think it would make a great deal of difference for supporting these themes as well as allowing end users to have a method of finding which page to edit.</div>
<div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif"><br></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">
Using something standard like</div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif"><br></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">
<!-- TEMPLATE FILE footer.php Start --></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif"><!-- TEMPLATE FILE footer.php End --></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">
<br></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">or for hooks</div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">
<br></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif"><!-- TEMPLATE HOOK wp_footer Start --></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">
<!-- TEMPLATE HOOK wp_footer End --></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif"><br></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">
I just went through real quick and adding some on <a href="http://www.wpbum.com/how-to-get-jobs-on-odesk.html" target="_blank">http://www.wpbum.com/how-to-get-jobs-on-odesk.html</a> for just page template and only took a few minutes. But by viewing the source code it makes it really easy to see where all the code is being generated from and where to go to edit.<br>
</div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif"><br></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">
Why isn't something like this a standard?</div><span><font color="#888888"><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif"><br></div><div style="font-style:normal;font-size:16px;background-color:transparent;font-family:tahoma,new york,times,serif">
Aaron<br></div></font></span></div></div><br>_______________________________________________<br>
theme-reviewers mailing list<br>
<a rel="nofollow" href="mailto:theme-reviewers@lists.wordpress.org" target="_blank">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></blockquote></div><br></div>
</div><br>_______________________________________________<br>theme-reviewers mailing list<br><a href="mailto:theme-reviewers@lists.wordpress.org" target="_blank">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><br> </div></div></div> </div> </div></div><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></blockquote></div><br></div>