[theme-reviewers] Handling errors in commenting

[Chip Bennett]

We have no explicit guidelines about inline documentation.

You can certainly recommend changes to inline documentation (especially if
the documentation is wrong/inconsistent/misleading/etc.), but at current
such issues wouldn't fall under REQUIRED.

Exceptions would be:
1) Inline documentation that contradicts the license
2) Obvious copy-pasta (e.g. references to TwentyTen, etc.)
3) Similar

Chip

On Fri, Oct 7, 2011 at 3:06 PM, Kirk Wight <kwight at kwight.ca> wrote:

> Hello,
>
> How do we grade errors in commenting? Theme developers sometimes miss
> correcting code comments when their theme is based on another theme; for
> example, referencing a widget or function that no longer exists in their own
> version of the theme.
>
> Do we just RECOMMEND that the errors are corrected (since inaccurate
> comments don't affect how the theme operates), or is it REQUIRED that all
> commenting be as accurate as possible?
>
>  Kirk
>
> _______________________________________________
> 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/20111007/64f62c2d/attachment.htm>