Documentation problem with hook_schema

This is in the example function body for hook_schema, and is present in Drupal 7 as well. Should be fixed in D7 first.

Good project for a novice Drupal contributor...

I'll Bite, diff attached.

question though, why is the comment

// example (partial) specification for table "node"

under hook_schema()

shouldn't it be in the doc block above something like

* A schema definition structure array. For each element of the
* array, the key is a table name and the value is a table structure
* definition. The following example is a partial specification for the
* "node" table.

Regarding your question about comment placement -- No. The docblock should document what the hook does and what its params and return value are. The function body gives an example, and any documentation that is specific to that particular example should go as code comments in the function body.

So, after you submit a patch, you should set the status to "needs review" so that (a) patch reviewers are aware that you have a patch that you think is ready to go and (b) the testing bot will launch to make sure the patch is OK.

In this case, I will go ahead and bypass "needs review" and mark it "reviewed".

Thanks!

Please mark this as D6 / to be ported if committing, thanks!

Committed to CVS HEAD.

I fixed it in the D6 contrib repository too.