Closed (fixed)
Project:
Drupal core
Version:
6.x-dev
Component:
documentation
Priority:
Normal
Category:
Bug report
Assigned:
Issue tags:
Reporter:
Created:
28 Aug 2010 at 02:25 UTC
Updated:
3 Jan 2014 at 02:04 UTC
Jump to comment: Most recent, Most recent file
Comments
Comment #1
jhodgdonThanks for reporting this. It was fixed in the Drupal 7 version, but not in Drupal 6.
Needs to have
@see l
changed to
see l()
on that line of the documentation, so that l() will turn into a link to the l() function automatically. http://api.drupal.org/api/function/l
A good project for a novice drupal contributor...
Comment #2
dstolHere you go.
Comment #3
jhodgdonOh. Actually now that I look at the line you patched, it should not have @see there at all. We don't put @see inside a @param or @return section, because it starts a completely new See Also section. It should just be the word See. Can you fix that too?
Comment #4
dstolUpdated with your suggestions.
Comment #5
dstolBeh, updating case.
Comment #6
jhodgdonSorry for the delay in reviewing...
The list in this function param is not formatted according to guidelines:
http://drupal.org/node/1354#lists
I am reluctant to mark this patch RTBC since the function doc being fixed is out of compliance with our standards...
Comment #7
dstolNo worries, I'm learning.
Comment #8
jhodgdonThanks... That's closer, but the list is still not compliant. List items should look like:
And there should be a blank line between the end of the @param and the @return.
Comment #9
dstolTry, try again. Sorry I'm missing these and thanks for sticking it out with me.
Comment #10
dstolComment #11
jhodgdonthat's better, thanks!
This is definitely an improvement on the existing docs, and fixes the reported problem. Let's get it in...
Comment #13
jhodgdonThis patch is fine. The test bot is acting strange and saying "can't find file to patch at input line 8"
Comment #14
gábor hojtsyCommitted, thank you.