[theme-reviewers] @package WordPress in DocBlock

[Edward Caissie]

Absolutely, we can definitely add this as a "RECOMMENDED" item ... it will
most likely be a reviewer's eye-on approach for the foreseeable future, too.
It would be good practice to insure the documentation is readily available
(inline) especially as we approach the derivative themes issues.

We can leave it to Simon and Otto for sorting out how to add it to the
Theme-Checks but it strikes me as something much too arbitrary to
"conditionally" check.


Cais.


On Sat, Oct 15, 2011 at 12:17 PM, Chip Bennett <chip at chipbennett.net> wrote:

> Hey, if you think that it's time to move in that direction, I'm all for it!
> :)
>
> I generally do list @package/@subpackage as *recommended* in my reviews now
> anyway, when I see Themes using @package: WordPress. But if we want to begin
> formalizing it, that's great.
>
> But I do see this as RECOMMENDED, for the foreseeable future.
>
> Chip
>
> On Sat, Oct 15, 2011 at 11:15 AM, Edward Caissie <edward.caissie at gmail.com
> > wrote:
>
>> Although we have no say over how Plugins and their guidelines are created
>> and implemented it does strike me as a good idea to follow suit on items
>> that make sense; in this case I would agree the Theme guidelines should be
>> making similar references to how the theme's inline documentation (i.e.:
>> phpDocs) is written, more for some sort of consistent approach than anything
>> else.
>>
>> This is something that can be put forward as part of the "new" v3.3
>> guidelines: Documentation Recommendations (and Requirements, as applicable).
>>
>>
>> Cais.
>>
>>
>> On Sat, Oct 15, 2011 at 12:03 PM, Kirk Wight <kwight at kwight.ca> wrote:
>>
>>>  Are we allowing "@package WordPress" references in theme DocBlocks?
>>>
>>> I found one list reference<http://lists.wordpress.org/pipermail/theme-reviewers/2010-November/003118.html> questioning
>>> the practice based on plugin guidelines, but available themes such as Duster
>>> and Coraline still have them. Should they be accepted?
>>>
>>> _______________________________________________
>>> 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/20111015/e00dca8b/attachment.htm>