More information on the data structure of these parameters would be helpful.

Files: 
CommentFileSizeAuthor
#8 menu-menutreedatadoc-1050606-8.patch1.92 KBbxtaylor
PASSED: [[SimpleTest]]: [MySQL] 36,080 pass(es).
[ View ]
#2 1050606.patch2.04 KBjhodgdon
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 1050606.patch. See the log in the details link for more information.
[ View ]

Comments

Title:Documentation problem with menu_tree_datamenu_tree_data doc needs more detail

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

Status:Active» Needs review
StatusFileSize
new2.04 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch 1050606.patch. See the log in the details link for more information.
[ View ]

Here's a patch. Definitely needs a review...

Version:7.x-dev» 8.x-dev

8.x now

#2: 1050606.patch queued for re-testing.

#2: 1050606.patch queued for re-testing.

Status:Needs review» Needs work

The last submitted patch, 1050606.patch, failed testing.

Looks like this needs a reroll. Probably a good novice project? Then needs a review...

StatusFileSize
new1.92 KB
PASSED: [[SimpleTest]]: [MySQL] 36,080 pass(es).
[ View ]

Rerolled.

Status:Needs work» Needs 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!

Status:Needs review» Reviewed & tested by the community

Thanks @bxtaylor.

No problem @xjm. After review, the patch text makes sense to me and looks accurate.

Ditto on the clarity! Nice, simple, and direct!

Version:8.x-dev» 7.x-dev

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.

Status:Reviewed & tested by the community» Fixed

Committed and pushed to 7.x. Thanks!

Status:Fixed» Closed (fixed)
Issue tags:-Novice, -needs backport to D7

Automatically closed -- issue fixed for 2 weeks with no activity.