The function drush_rows_of_key_value_to_array_table() has a parameter $metadata. One of the keys, 'field-mappings', is not documented. It is passed to drush_lookup_field_by_path() as its $mapping parameter, which is also not documented.

I will start working on a patch as soon as I create this issue. Or maybe after dinner.

CommentFileSizeAuthor
#1 drush-docs-2047209-1.patch2.9 KBbenjifisher
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

benjifisher’s picture

benjifisher
he/him or they/them
Primary language English
Location Boston area
CreditAttribution: benjifisher commented
Title: The 'field-mappings' key is not documented in drush_lookup_field_by_path() and drush_rows_of_key_value_to_array_table() » Document $mapping in drush_lookup_field_by_path() and 'field-mappings' in drush_rows_of_key_value_to_array_table()
Status: Active » Needs review
FileSize
drush-docs-2047209-1.patch2.9 KB

The attached patch adds to the two documentation blocks as indicated in the issue summary.

The patch also updates the doc block for drush_rows_of_key_value_to_array_table():

  1. Add a missing ).
  2. Reformat the lists to make them closer to the Drupal standards.

I am not sure how to test, but I hope this will make the API page for this function easier to read.

moshe weitzman’s picture

moshe weitzman CreditAttribution: moshe weitzman commented
Status: Needs review » Fixed

Committed. Thanks.

Status: Fixed » Closed (fixed)

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

Anonymous’s picture

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

More accurate description.