block.module has a couple of functions that are missing @phpdocs
| Comment | File | Size | Author |
|---|---|---|---|
| #12 | 554992_D6.patch | 1.41 KB | jhodgdon |
| #8 | 554992.patch | 1.4 KB | jhodgdon |
| #5 | block-phpdoc-554992-3.patch | 1.03 KB | davyvdb |
| #3 | block-phpdoc-554992-2.patch | 1.03 KB | davyvdb |
| #2 | block-phpdoc-554992-2.patch | 2.87 KB | davyvdb |
Comments
Comment #1
davyvdb commentedComment #2
davyvdb commentedDon't trust the previous one. Had some leftovers from another patch. This is the one.
Comment #3
davyvdb commentedIgnore previous one again. I should stop patching for today :(
Comment #4
dries commentedIn documentation, we write ID instead of id. Quick reroll?
Comment #5
davyvdb commentedComment #6
jhodgdonFunction descriptions should be in 3rd person. E.g. "gets" vs. "get" and "saves" vs. "save".
Also, I would prefer to see a bit more description of the return values. block_box_get() should say something like
An associative array containing the box information from the database.
rather than
The box.
What is a box, anyway?
On the save function, is the return value always TRUE? That seems odd. Why would a function return TRUE in all cases?
Comment #7
jhodgdonChanging component also. Normally, API doc issues are put into component "documentation. And it is a doc "bug" of normal priority if some functions are missing doc.
Comment #8
jhodgdonHmmm... It appears that block_box_get() and block_box_save() have changed names in Drupal 7 since this patch was submitted. They are now called block_custom_block_get() etc. And they are still missing doc. All of the other functions in the block module have doc (not necessarily great doc, but at least a doc block).
The corresponding D6 functions are also missing doc, so if this patch is accepted for D7, it should then be backported (with appropriate function names) to D6.
Comment #9
jhodgdonComment #10
dries commentedCommitted to CVS HEAD. Thanks.
Comment #11
jhodgdonNeeds port to D6.
Comment #12
jhodgdonHere's a Drupal 6 port of the patch. Same functions, different names, exact same functionality. Marking RTBC as it's the same patch approved for D7.
Comment #13
gábor hojtsyThanks, committed to Drupal 6.