API page: http://api.drupal.org/comment/reply/19114

Return value is a string, not an array.

CommentFileSizeAuthor
#8 d8_node.api-updated_doc-1472614.patch798 bytesfilijonka
#5 d8_node.api-updated_doc-1472614.patch798 bytesfilijonka
#3 node-apidoc_update-1272614.patch746 bytesfilijonka
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

filijonka’s picture

filijonka CreditAttribution: filijonka commented
Status: Active » Postponed (maintainer needs more info)

could you please give us the function page to which this report belongs to?

pfournier’s picture

pfournier CreditAttribution: pfournier commented

Yes, sorry I did not check the link URL.

http://api.drupal.org/api/drupal/modules!node!node.api.php/function/hook...

filijonka’s picture

filijonka CreditAttribution: filijonka commented
Status: Postponed (maintainer needs more info) » Needs review
FileSize
node-apidoc_update-1272614.patch746 bytes

changed

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Title: Wrong return value » Wrong return value docs for hook_node_update_index()
Version: 7.x-dev » 8.x-dev
Status: Needs review » Needs work
Issue tags: +Novice

Good catch! Both the example in the hook docs and the two implementations of hook_node_update_index() do indeed return strings and not arrays.

I think we can make the wording better though... "String of additional information to be indexed." is ... awkward? Can you think of a better way to say that?

And the initial patch needs to be made for 8.x.

filijonka’s picture

filijonka CreditAttribution: filijonka commented
FileSize
d8_node.api-updated_doc-1472614.patch798 bytes

better perhaps?

filijonka’s picture

filijonka CreditAttribution: filijonka commented
Status: Needs work » Needs review
jhodgdon’s picture

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

Much better!

The only thing to fix is that the return value type should be lower-case "string", not upper-case "String". See
http://drupal.org/node/1354#param-return-data-type

filijonka’s picture

filijonka CreditAttribution: filijonka commented
Status: Needs work » Needs review
FileSize
d8_node.api-updated_doc-1472614.patch798 bytes

when things are to easy we rush through them..sorry for wasting the time on trivia stuff

jhodgdon’s picture

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

That looks fine, thanks! I'll get it committed shortly.

jhodgdon’s picture

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

Committed to 8.x and 7.x.

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