Posted by TravisCarden on April 14, 2012 at 2:28am
6 followers
| Project: | Drupal core |
| Version: | 7.x-dev |
| Component: | documentation |
| Category: | bug report |
| Priority: | normal |
| Assigned: | TravisCarden |
| Status: | closed (fixed) |
| Issue tags: | documentation, Novice |
Issue Summary
The DocBlock comments on comment_reply() document the return value thus:
<?php
/**
* @return
* The rendered parent node or comment plus the new comment form.
*/
?>That's not correct. What's actually returned is an array containing a renderable array for the node or parent comment and the comment form as an array. I propose the comment be changed to read something like this:
<?php
/**
* @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.
*/
?>When there's consensus on the change I'll roll a patch.
Comments
#1
Tagging.
#2
I like this, but I'm not sure about the established conventions for describing the presence of things like comment_node/comment_parent. In fact, I wonder why the key here needs to change at all.
Please go ahead and make patches in situations like this, that way the status could have been "Needs review" already and can attract the appropriate attention. Tags help too.
#3
Can do! Thanks.
#4
Re-rolled.
#5
The patch updates the code as per the summary.
#6
Committed to 8.x. Moving to 7.x. for back porting.
#7
Great! Here's the same thing for d7. (Can I put it right into RTBC?)
#8
I don't see this in D8 yet.. anyone else?
Let's also move it to the documentation queue - @jhodgdon will likely snag reviewing/committing it there before any of the rest of us gets around to it :)
#9
Um, I forgot to actually move it, apparently.
#10
Committed it to 8.x. For real now. Moving back to 7.x.
#11
I still don't see the commit. It should be in the repository pretty much immediately, right?
#12
You're right, maybe it was committed but never pushed? I'm actually seeing the same thing for a few other issues too, so I will bump them back to Drupal 8 also.
#4 is still RTBC for Drupal 8. Hopefully third time's the charm :)
#13
Forgot to push my changes. It is committed now: http://drupalcode.org/project/drupal.git/commit/1ed9d79.
#14
I see you learned my trick - if you paste the commit link into the issue, that guarantees you'll never forget to push :)
#7 looks RTBC for Drupal 7 to me.
#15
The patch in #7 has been committed (and pushed :) ) to Drupal 7.x. Thanks!
#16
Automatically closed -- issue fixed for 2 weeks with no activity.