[wp-forums] Hoisted by my own petard...

[Chip Bennett]

Kim,

I'd love to see inline documentation standards for Themes, but I'm pretty
sure I'd face a mutiny if I suggested making the core standards as
required. :)

I will certainly make sure those standards get highlighted as
recommended/best-practice, though.

I would love to see auto-parsing both of inline docs, and of the Theme's
readme.txt file.


On Wed, Jan 29, 2014 at 8:59 AM, Kim Parsell <kpdesign3 at gmail.com> wrote:

> Chip -
>
> Re: #7 in your post - there is already an inline documentation standard
> for the WordPress project:
> http://make.wordpress.org/core/handbook/inline-
> documentation-standards/php-documentation-standards/
>
> All of the bundled themes (2010/2011/2012/2013/2014) have inline
> documentation.
>
> Perhaps the Theme Review Team can point theme authors to that standard,
> and suggest they start including it in their themes (optional, just a
> suggestion)?
>
> Another possibility for theme docs: The parser that will create the
> function/class/hook documentation for developer.wordpress.org *might* be
> able to be used to create theme documentation. Maybe something to discuss
> with the Meta Team to see if it's possible?
>
> Kim
>
>
>
> On 1/29/2014 8:30 AM, Chip Bennett wrote:
>
>> Just added some comments as well.
>>
>> Please feel free to ping me @chipbennett on any support/feedback topics
>> you
>> encounter that involve Theme Review/Guidelines.
>>
>>
>> On Wed, Jan 29, 2014 at 7:43 AM, Jan Dembowski <jan at dembowski.net> wrote:
>>
>>  On Wed, Jan 29, 2014 at 7:08 AM, esmi wrote:
>>>
>>>  <http://wordpress.org/support/topic/how-about-some-
>>>> documentation-1?replies=22>
>>>>
>>>> tl;dr: having talked the OP around, he's now willing to actually do
>>>> something about theme & plugin documentation himself instead of
>>>> insisting
>>>> that an undefined "they" do.
>>>>
>>>> Whilst the obvious answer is "contact each developer", I'd rather not
>>>> end
>>>> with a reply that sounds like a fob off. I've pointed him towards Docs
>>>>
>>> but
>>>
>>>> that's really not the right place.
>>>>
>>>> Anyone have any bright ideas?
>>>>
>>> Saw that and laughed too (at the situation not at, well you get it). It
>>> looks like the problem that user has is with the individual themes and
>>> plugins documentation so aside from contacting each developer I don't
>>> think
>>> there's much to do.
>>>
>>> I thought it was good of you to suggest that the user review your eShop
>>> plugin documentation but aside from contacting the Docs team I'm not sure
>>> what else can be suggested.
>>>
>>> Some of the theme and plugin authors may not want another person writing
>>> or
>>> critiquing their documentation that way.
>>>
>>> Jan Dembowski
>>>
>> _______________________________________________
> wp-forums mailing list
> wp-forums at lists.automattic.com
> http://lists.automattic.com/mailman/listinfo/wp-forums
>