Problem/Motivation

  • taxonomy_autocomplete() documentation lacks proper API documentation.
  • Multiple open issues need to update this docblock, and so far each issue includes its own variant.

See also: #1326644: Clean up API docs for taxonomy module

Proposed resolution

Stop the madness. :) Give this function a docblock sooner rather than later so that every bugfix doesn't write its own variant. Patch in #3 adds this docblock.

Remaining tasks

None.

User interface changes

None.

API changes

None.

CommentFileSizeAuthor
#9 taxonomy_autocomplete-d7-1337124-9.patch1.54 KBxjm
#6 taxonomy_autocomplete-1337124-6.patch1.56 KBxjm
#3 taxonomy_autocomplete-1337124-3.patch1.56 KBxjm
#2 taxonomy_autocomplete_docblock.patch1.56 KBxjm
#1 taxonomy_autocomplete_docblock.patch1.56 KBxjm

Comments

xjm’s picture

xjm
she/her
Primary language English
commented
Status: Active » Needs review
StatusFileSize
new taxonomy_autocomplete_docblock.patch1.56 KB
xjm’s picture

xjm
she/her
Primary language English
commented
StatusFileSize
new taxonomy_autocomplete_docblock.patch1.56 KB

And without the whitespace this time.

xjm’s picture

xjm
she/her
Primary language English
commented
StatusFileSize
new taxonomy_autocomplete-1337124-3.patch1.56 KB

ksenzee pointed out it's an object, not an array. Curse you, JavaScript!

ksenzee’s picture

ksenzee
she/her
commented
Status: Needs review » Reviewed & tested by the community

Looks good to me.

ksenzee’s picture

ksenzee
she/her
commented
Issue summary: View changes

Updated issue summary.

xjm’s picture

xjm
she/her
Primary language English
commented
Issue summary: View changes

Updated issue summary.

xjm’s picture

xjm
she/her
Primary language English
commented
Issue summary: View changes

Updated issue summary.

xjm’s picture

xjm
she/her
Primary language English
commented
Issue summary: View changes

Updated issue summary.

xjm’s picture

xjm
she/her
Primary language English
commented
Issue summary: View changes

Updated issue summary.

catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Needs review 
+ * @code
+ *   {
+ *     "red fish, blue fish": "blue fish",
+ *     "red fish, blue moon": "blue moon",
+ *   };
+ * @endcode
+ *
+ *
+ * @param $field_name

Looks like one too many line breaks?

xjm’s picture

xjm
she/her
Primary language English
commented
StatusFileSize
new taxonomy_autocomplete-1337124-6.patch1.56 KB

That is entirely possible.

aspilicious’s picture

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

RTBC again

catch’s picture

catch
he/him
Primary language English
commented
Version: 8.x-dev » 7.x-dev
Status: Reviewed & tested by the community » Patch (to be ported)

Committed/pushed to 8.x, will need a re-roll for 7.x.

xjm’s picture

xjm
she/her
Primary language English
commented
Status: Patch (to be ported) » Reviewed & tested by the community
StatusFileSize
new taxonomy_autocomplete-d7-1337124-9.patch1.54 KB

Same docblock, different branch.

xjm’s picture

xjm
she/her
Primary language English
commented
Assigned: xjm » Unassigned
dries’s picture

dries commented
Status: Reviewed & tested by the community » Fixed

Committed to 7.x.

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

Anonymous’s picture

(not verified) commented
Issue summary: View changes

Making it a bit more legible. ;)