More information on the data structure of these parameters would be helpful.
OK. Someone will need to research this and figure out what the data structure is.
There's another minor problem with this docblock: in the @return, menu_tree_page_data function name should have () after it so it turns into a link on api.drupal.org
Here's a patch. Definitely needs a review...
#2: 1050606.patch queued for re-testing.
The last submitted patch, 1050606.patch, failed testing.
Looks like this needs a reroll. Probably a good novice project? Then needs a review...
Thanks for the reroll! Someone other than me needs to review the text in the patch also for accuracy and clarity (since I wrote the original patch, I cannot review it). Would you like to comment on the patch text?
Ah yes! It gets kinda lonely in an issue all by yourself ; ) I'll review the text. Should I just mark as reviewed when done?
What's the standard for paragraph spacing in comments? Sometimes there's an extra line, sometimes not.
* @param $parents * An array of the menu link ID values that are in the path from the current * page to the root of the menu tree. * @param $depth * The minimum depth to include in the returned menu tree. * <----- This is an extra line * @return * An array of menu links in the form of a tree. Each item in the tree is an * associative array containing: * - link: The menu link item from $links, with additional element * 'in_active_trail' (TRUE if the link ID was in $parents).
Nevermind, I read somewhere else in the core issue queue that it is standard for an extra line to be in between the @param and the @return. Still reviewing the text in the patch.
The standards for formatting of documentation blocks are at:http://drupal.org/node/1354
Thanks for reviewing!
No problem @xjm. After review, the patch text makes sense to me and looks accurate.
Ditto on the clarity! Nice, simple, and direct!
This looks like a good improvement to me. Committed to 8.x and moving back to 7.x for webchick.
#8: menu-menutreedatadoc-1050606-8.patch queued for re-testing.
Committed and pushed to 7.x. Thanks!
Automatically closed -- issue fixed for 2 weeks with no activity.
Restoring issue tags, see #2125755: System messages removed all issue tags during D7 upgrade.
Drupal is a registered trademark of Dries Buytaert.