Because of its prominence and key functions, the file bootstrap.inc will require its own patch for variable type hinting in the @param and @return directives. @webchick has indicated that this type of patch will not be backported to D7. This is also a lower priority patch to some of the other API documentation clean up work that is on-going.
The attached patch contains work in progress toward a complete patch for the variable type hinting in bootstrap.inc.
#1331240: [Meta] Correct documentation for 'list' related issues
| Comment | File | Size | Author |
|---|---|---|---|
| #4 | 1333474-bootstrap_type_hint-4.patch | 16.1 KB | albert volkman |
| #1 | Bootstrap_Variable_Type_Hinting-1333474-1.patch | 26.77 KB | lars toomre |
Comments
Comment #1
lars toomre commentedAttached is work in progress about adding variable type hinting to all @param and @return directives in the rather large and prominent file bootstrap.inc.
This work covers most of the functions. However, some @param and/or @return directives are missing that are being added in other 2011 API documentation sprint issues #1310084: [meta] API documentation cleanup sprint. There are also some questions about particular variable types that can be found by searching for '???'.
One will need to check for completeness of coverage before final patch review for commitment.
Comment #2
thedavidmeister commented#1: Bootstrap_Variable_Type_Hinting-1333474-1.patch queued for re-testing.
Comment #4
albert volkman commentedRe-roll, but there's several more missing type-hints.
Comment #5
thedavidmeister commentedare you saying that the patch needs to be extended to add more type-hints for full coverage of bootstrap.inc? because if so that means this issue needs work.
Comment #6
albert volkman commentedYep, I was just setting it to NR so that it'd get tested.
Comment #6.0
albert volkman commentedAdded cross-reference to #1331240.
Comment #7
jhodgdonI'm closing very old coding standards fixup issues. They are being addressed on other issues mostly.