I constantly have trouble understanding this function so I wrote this. Maybe it needs to be in @return, maybe not, I am not sure.

CommentFileSizeAuthor
#7 1973762_7.patch727 byteschx
docs.patch667 byteschx
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

cosmicdreams’s picture

cosmicdreams CreditAttribution: cosmicdreams commented

looks good to me but you might want someone on the documentation team to review this. Is there anyway to test the syntax to see if it properly documents (perhaps using simplytest.me?)

chx’s picture

chx CreditAttribution: chx commented
Assigned: Unassigned » yched
yched’s picture

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

Looks good to me. Thanks !

chx’s picture

chx CreditAttribution: chx commented
Issue tags: +Needs backport to D7

also for D7.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Assigned: yched » jhodgdon

This one's for Jennifer.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Reviewed & tested by the community » Needs work

I think the example does belong in the @return section, since it describes the return value (and when re-patching, don't leave blank lines within the @return). Thanks!

chx’s picture

chx CreditAttribution: chx commented
Status: Needs work » Reviewed & tested by the community
FileSize
1973762_7.patch727 bytes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Assigned: jhodgdon » Unassigned
Status: Reviewed & tested by the community » Fixed

Thanks! Committed to both 8.x and 7.x.

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

Anonymous’s picture

(not verified) CreditAttribution: commented
Issue summary: View changes

Updated issue summary.