[development] Let's finally document our schema already!

Neil Drumm drumm at delocalizedham.com
Thu Aug 9 06:11:00 UTC 2007

On 8/8/07, Angela Byron <drupal-devel at webchick.net> wrote:
> On 9-Aug-07, at 1:42 AM, Neil Drumm wrote:
> > Documentation comments would be much better. They are in code, but
> > have the advantage of not being code. The challenge is figuring out a
> > convenient and consistent comment syntax.
> As long as it's in-line with the schema source code, it doesn't
> matter much to me what format it takes. But it **MUST** be in the
> actual source code of the .schema file, and not stored in a separate
> document (like the FAPI reference) or it will very quickly fall
> hopelessly out of date with what the code actually says (like the
> FAPI reference :P~).

In the code is where documentation comments belong.

If we get a decent array documentation construct it might be useful
elsewhere. Drupal tends to accumulate arrays.

Neil Drumm

More information about the development mailing list