This is probably something I only care about because I'm relatively new, but I'd like if hook_schema contained a description of what was intended for each field - even if it seems super redundant to a veteran drupal dev. Descriptions in .install file would have saved me quite a few minutes of digging around.
I applied this patch against 2.x branch, the latest out of git at the moment.
Not sure that my understanding of every field is correct, but they seem pretty straight forward. If you mark it from "reviewed" to "tested", just make sure you at least skim over each description to double check what I wrote.
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | flag_hook_schema_descriptions.patch | 5.13 KB | quicksketch |
| #1 | hook_schema_descriptions-1095348.patch | 5.93 KB | jzacsh |
Comments
Comment #1
jzacsh commentedAttached is the patch for hook_schema() changes to add description fields. Did some (quick) googling and it looks like you don't need to run hook_update_n() for simple description fields. (I guess they're only their for us to read). Let me know if I'm wrong about that.
Also in the patch is a commit for tiny php syntax/style clean-up on one line, near by code I was editing in hook_schema().
[ edit figured out the proper `git` way of creating a patch. ]
Comment #2
jzacsh commentedHmm.. maybe having this assigned to myself means no one is seeing it in their searches.
Comment #3
avpaderno@jzacsh Assigning a bug report to yourself just means you are going to work on a patch, and you will work on that patch until it's not perfect to be committed. Everybody can still see the report, even if it's assigned to yourself.
Comment #4
jzacsh commentedThanks, I didn't mean that people can't see it -- I meant more, "maybe this ticket isn't getting responded to because the appropriate developers only watch the issue queue and filter by unassigned bugs".
Anyway, I think this is ready to be used.
Comment #5
quicksketchThanks jzacsh, I revised your patch slightly to fix a grammatical error, capitalizing "UNIX", and adding the word "usually" in a lot of places. While you're right that out-of-box Flag module only supports nodes, users, and comments, other modules can extend Flag's ability to flag other things such as taxonomy terms or anything with a unique numeric ID. So I revised the documentation to say "usually" before your examples. Thanks for the patch, much appreciated!
Attached is the committed patch.
Comment #6
quicksketch