[theme-reviewers] Rule Addition?

[Edward Caissie]

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.

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.

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.

Edward Caissie
aka Cais.


On Sat, Feb 2, 2013 at 4:29 PM, Aaron Nimocks <aaron_nimocks at yahoo.com>wrote:

> 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. :)
>
> Any other feedback?
>
> Aaron
>
>
>   ------------------------------
> *From:* Edward Caissie <edward.caissie at gmail.com>
> *To:* WP Theme Reviewers Mailing List <theme-reviewers at lists.wordpress.org>
>
> *Sent:* Saturday, February 2, 2013 1:12 PM
> *Subject:* Re: [theme-reviewers] Rule Addition?
>
> 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).
>
> 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.
>
> 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).
>
> Edward Caissie
> aka Cais.
>
>
> On Sat, Feb 2, 2013 at 9:12 AM, Aaron Nimocks <aaron_nimocks at yahoo.com>wrote:
>
> 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.
>
> 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.
>
> Using something standard like
>
> <!-- TEMPLATE FILE footer.php Start -->
> <!-- TEMPLATE FILE footer.php End -->
>
> or for hooks
>
> <!-- TEMPLATE HOOK wp_footer Start -->
> <!-- TEMPLATE HOOK wp_footer End -->
>
> I just went through real quick and adding some on
> http://www.wpbum.com/how-to-get-jobs-on-odesk.html 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.
>
> Why isn't something like this a standard?
>
> Aaron
>
> _______________________________________________
> theme-reviewers mailing list
> theme-reviewers at lists.wordpress.org
> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>
>
>
> _______________________________________________
> theme-reviewers mailing list
> theme-reviewers at lists.wordpress.org
> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>
>
>
> _______________________________________________
> theme-reviewers mailing list
> theme-reviewers at lists.wordpress.org
> http://lists.wordpress.org/mailman/listinfo/theme-reviewers
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.wordpress.org/pipermail/theme-reviewers/attachments/20130202/f424781a/attachment.htm>