From 1ed9d79463ac131577ab6d4e35f063af506da5ef Mon Sep 17 00:00:00 2001 From: Dries Date: Sun, 3 Jun 2012 21:47:05 -0400 Subject: [PATCH] - Patch #1532682 by TravisCarden: fixed documentation of comment_reply() return value. --- core/modules/comment/comment.pages.inc | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/core/modules/comment/comment.pages.inc b/core/modules/comment/comment.pages.inc index 39b8a24456b..028b145032b 100644 --- a/core/modules/comment/comment.pages.inc +++ b/core/modules/comment/comment.pages.inc @@ -26,8 +26,12 @@ use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; * (optional) Some comments are replies to other comments. In those cases, * $pid is the parent comment's comment ID. Defaults to NULL. * - * @return - * The rendered parent node or comment plus the new comment form. + * @return array + * An associative array containing: + * - An array for rendering the node or parent comment. + * - comment_node: If the comment is a reply to the node. + * - comment_parent: If the comment is a reply to another comment. + * - comment_form: The comment form as a renderable array. */ function comment_reply(Node $node, $pid = NULL) { // Set the breadcrumb trail.