The D7 doc header for user_load has some formatting issues around @code and @link.

- The @code is inline, but API module always sets @code sections not inline; I think the @code/@endcode should be omitted.
- The @link I think needs to be all on one line for the API module to recognize it. I'm not sure about that, but it's not being recognized currently. See
#847322: @link should be recognized even if it crosses a line boundary
(issue on the API module discussing this issue)

CommentFileSizeAuthor
#10 847324-10.patch1.03 KBjhodgdon
#4 847324.patch960 bytesjhodgdon
#1 847324.patch953 bytesyang_yi_cn
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

yang_yi_cn’s picture

yang_yi_cn CreditAttribution: yang_yi_cn commented
Status: Active » Needs review
FileSize
847324.patch953 bytes

this patch fixes the @link issue

yang_yi_cn’s picture

yang_yi_cn CreditAttribution: yang_yi_cn commented 
+++ modules/user/user.module	31 Jul 2010 18:02:42 -0000
@@ -310,8 +310,7 @@ class UserController extends DrupalDefau
- * another user @endlink for more information.
+ * @endcode first. See @link http://drupal.org/node/218104 Safely impersonating another user @endlink for more information.

this line changed

Powered by Dreditor.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Needs work

Yeah, this patch doesn't fix the issues identified in the issue report. The @code was not removed.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs work » Needs review
FileSize
847324.patch960 bytes

Here's a patch that removes the @code tags, as they are unnecessary IMO.

The API module should take care of the @link problem.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

#4: 847324.patch queued for re-testing.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

#4: 847324.patch queued for re-testing.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

#4: 847324.patch queued for re-testing.

Status: Needs review » Needs work

The last submitted patch, 847324.patch, failed testing.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

Re-roll time...

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs work » Needs review
FileSize
847324-10.patch1.03 KB

Here's a new patch. I moved the @link to its own line, which goes past 80 characters but at least should format correctly this way.

marcingy’s picture

marcingy CreditAttribution: marcingy commented
Status: Needs review » Reviewed & tested by the community

Looks good

Dries’s picture

Dries CreditAttribution: Dries commented
Status: Reviewed & tested by the community » Fixed

Committed to CVS HEAD. Thanks.

Status: Fixed » Closed (fixed)

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