Posted by aquariumtap on February 4, 2011 at 2:11am
7 followers
| Project: | Drupal core |
| Version: | 7.x-dev |
| Component: | documentation |
| Category: | bug report |
| Priority: | normal |
| Assigned: | Unassigned |
| Status: | closed (fixed) |
| Issue tags: | needs backport to D7, Novice |
Issue Summary
More information on the data structure of these parameters would be helpful.
Comments
#1
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
#2
Here's a patch. Definitely needs a review...
#3
8.x now
#4
#2: 1050606.patch queued for re-testing.
#5
#2: 1050606.patch queued for re-testing.
#6
The last submitted patch, 1050606.patch, failed testing.
#7
Looks like this needs a reroll. Probably a good novice project? Then needs a review...
#8
Rerolled.
#9
#10
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?
#11
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?
#12
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).
#13
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.
#14
The standards for formatting of documentation blocks are at:
http://drupal.org/node/1354
Thanks for reviewing!
#15
Thanks @bxtaylor.
#16
No problem @xjm. After review, the patch text makes sense to me and looks accurate.
#17
Ditto on the clarity! Nice, simple, and direct!
#18
This looks like a good improvement to me. Committed to 8.x and moving back to 7.x for webchick.
#19
#8: menu-menutreedatadoc-1050606-8.patch queued for re-testing.
#20
Committed and pushed to 7.x. Thanks!
#21
Automatically closed -- issue fixed for 2 weeks with no activity.