Closed (fixed)
Project:
Drupal core
Version:
6.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Issue tags:
Reporter:
Created:
30 Jun 2010 at 02:59 UTC
Updated:
3 Jan 2014 at 01:42 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonGood catch. This is only a problem in Drupal 6, not Drupal 7. Also, it's related to (but not a duplicate of):
#373606: file.inc documentation needs overhaul
Comment #2
jhodgdonThis particular fix would be a good project for a novice contributor. Just need to copy what's in Drupal 7 for this function to Drupal 6.
Comment #3
daniels220 commentedHere's a patch. I fixed up a couple other style issues in this function's doc as well.
An optional associative array...to(optional) An associative array...Added a blank line before @return.
Comment #4
jhodgdonI cannot get this patch to apply to D6 dev branch.
Also, if you are fixing up this function docblock, you could make it so the first line is a one-sentence summary, followed by a blank line?
Comment #5
daniels220 commentedProblems on my end sorted out, I think. Here's a new patch.
Comment #6
jhodgdonApplies and looks good, but it still doesn't bring the docblock into compliance, where the first line is a one-sentence summary, and it's followed by a newline and perhaps more description.
Comment #7
daniels220 commentedWhoops, I think I accidentally git reset'ed myself and didn't redo all my changes. Fixed by just moving the second sentence into the long description.
Comment #8
daniels220 commentedWhoops, I think I accidentally git reset'ed myself and didn't redo all my changes. Fixed by just moving the second sentence into the long description.
Comment #9
daniels220 commentedSorry for the double submit.
Comment #10
jhodgdonNitpick: There is a trailing space on the 2nd line. Other than that, the patch is good... To save time, I removed that space from the patch and here it is.
Comment #12
jhodgdonD6 test bot is not working. The patch is fine...
Comment #14
gábor hojtsySuperb, thanks, committed.