Under the arguments list --

options: An array of options, @see l for more.

See what?

Files: 
CommentFileSizeAuthor
#9 menu_link_save-895858-9.patch1.31 KBdstol
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-9.patch.
[ View ]
#7 menu_link_save-895858-7.patch1.67 KBdstol
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-7.patch.
[ View ]
#5 menu_link_save-895858-5.patch1 KBdstol
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-5.patch.
[ View ]
#4 menu_link_save-895858-4.patch1 KBdstol
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-4.patch.
[ View ]
#2 menu_link_save-895858-2.patch1 KBdstol
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-2.patch.
[ View ]

Comments

jhodgdon’s picture

Issue tags:+Novice

Thanks 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...

dstol’s picture

Assigned:Unassigned» dstol
Status:Active» Needs review
StatusFileSize
new1 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-2.patch.
[ View ]

Here you go.

jhodgdon’s picture

Status:Needs review» Needs work

Oh. 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?

dstol’s picture

Status:Needs work» Needs review
StatusFileSize
new1 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-4.patch.
[ View ]

Updated with your suggestions.

dstol’s picture

StatusFileSize
new1 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-5.patch.
[ View ]

Beh, updating case.

jhodgdon’s picture

Status:Needs review» Needs work

Sorry 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...

dstol’s picture

Status:Needs work» Needs review
StatusFileSize
new1.67 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-7.patch.
[ View ]

No worries, I'm learning.

jhodgdon’s picture

Status:Needs review» Needs work

Thanks... That's closer, but the list is still not compliant. List items should look like:

- item_name: Description starts with capital letter, ends with period.

And there should be a blank line between the end of the @param and the @return.

dstol’s picture

StatusFileSize
new1.31 KB
FAILED: [[SimpleTest]]: [MySQL] Unable to apply patch menu_link_save-895858-9.patch.
[ View ]

Try, try again. Sorry I'm missing these and thanks for sticking it out with me.

dstol’s picture

Status:Needs work» Needs review
jhodgdon’s picture

Title:Documentation problem with menu_link_save» menu_link_save has formatting issues
Status:Needs review» Reviewed & tested by the community

that's better, thanks!

This is definitely an improvement on the existing docs, and fixes the reported problem. Let's get it in...

Status:Reviewed & tested by the community» Needs work

The last submitted patch, menu_link_save-895858-9.patch, failed testing.

jhodgdon’s picture

Status:Needs work» Reviewed & tested by the community

This patch is fine. The test bot is acting strange and saying "can't find file to patch at input line 8"

Gábor Hojtsy’s picture

Status:Reviewed & tested by the community» Fixed

Committed, thank you.

Status:Fixed» Closed (fixed)
Issue tags:-Novice

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