[documentation] DBTNG docs need review

[Neil Drumm]

Yes, that is high on the list. We need to chunk the code into
functions/constants/etc with PHP's tokenizer instead of regular
expressions hard-coded to our coding conventions.
http://drupal.org/node/300031

-Neil

On Thu, Dec 18, 2008 at 8:18 AM, Larry Garfield <larry at garfieldtech.com> wrote:
>
> Changed the link on the first page of the docs to point to the database group directly.  API.module still needs to be taught how to handle classes, though.
>
> --Larry Garfield
>
> On Thu, 18 Dec 2008 09:54:21 +0000, "Nathaniel Catchpole" <catch56 at googlemail.com> wrote:
>> Just saw the docs here have been updated -
>> http://api.drupal.org/api/group/database/7 - this could do with a link to
>> the handbook section too though probably.
>>
>> Nat
>>
>> On Thu, Dec 18, 2008 at 4:28 AM, Larry Garfield
>> <larry at garfieldtech.com>wrote:
>>
>>> On Wednesday 17 December 2008 11:02:29 am you wrote:
>>> > Hi Larry,
>>> >
>>> > Nicely done on the documentation. Everything is easy to read, and well
>>> > organized. Great job!
>>> >
>>> > One thing to note is that hook.api.php files made it into core
>>> > (http://drupal.org/node/314870), so are there any places with the new
>>> > database layer that would benefit from having any extra
>> database.api.php
>>> > documentation files around?
>>> >
>>> > Thanks a lot,
>>>
>>> Hey neat, that made it in.
>>>
>>> I think DBTNG introduces only one hook, hook_query_alter, so I've opened
>> an
>>> issue for that:
>>>
>>> http://drupal.org/node/348519
>>>
>>> I'm not sure that in-code is the best place to document the rest of
>> DBTNG,
>>> beyond the docblocks already in database.inc.  The handbooks are
>> probably
>>> better as it's less API samples and more prose explanations.  That said,
>>> I'm
>>> fine if someone wants to copy portions of the handbooks into a docblock.
>>> (Technically the licenses are incompatible, but as the original author
>> of
>>> 98%
>>> of the DBTNG documentation I hereby dual-license it as needed yadda
>> yadda.)
>>>
>>> --
>>> Larry Garfield
>>> larry at garfieldtech.com
>>> --
>>> Pending work: http://drupal.org/project/issues/documentation/
>>> List archives: http://lists.drupal.org/pipermail/documentation/
>>>
>>
>>
>
> --
> Pending work: http://drupal.org/project/issues/documentation/
> List archives: http://lists.drupal.org/pipermail/documentation/
>



-- 
Neil Drumm
http://delocalizedham.com