Add API documentation.

See the documentation in the process plugins for format examples.

CommentFileSizeAuthor
#6 2862752-6.patch1.52 KBjofitz
#6 interdiff-3-6.txt1.32 KBjofitz
#3 2862752-3.patch1.38 KBjofitz
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

quietone created an issue. See original summary.

jofitz’s picture

jofitz CreditAttribution: jofitz at ComputerMinds commented
Assigned: Unassigned » jofitz
Status: Active » Needs review
jofitz’s picture

jofitz CreditAttribution: jofitz at ComputerMinds commented
Assigned: jofitz » Unassigned
FileSize
2862752-3.patch1.38 KB

Added the configuration keys and an example.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Assigned: Unassigned » phenaproxima

Self-assigning for review.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Status: Needs review » Needs work 
+++ b/core/modules/migrate/src/Plugin/migrate/destination/PerComponentEntityFormDisplay.php
@@ -5,6 +5,37 @@
+ * Available configuration keys:
+ * - entity_type: The entity type.
+ * - bundle: The entity bundle.
+ * - form_mode: The form mode.
+ * - field_name: The name of the field.
+ * - options: The display options.

As in this one's sister issue, I think we need to make it clear that these are elements of the imported row, not configuration keys. We should also expand on the descriptions (type, example values, etc.) -- the descriptions right now are pretty useless.

jofitz’s picture

jofitz CreditAttribution: jofitz at ComputerMinds commented
Status: Needs work » Needs review
FileSize
interdiff-3-6.txt1.32 KB
2862752-6.patch1.52 KB

Made the changes suggested by @phenaproxima in #5.

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Status: Needs review » Reviewed & tested by the community

Perfect! Pre-RTBC assuming Drupal CI passes.

  • catch committed d66f952 on 8.4.x 
    Issue #2862752 by Jo Fitzgerald, phenaproxima: Add documentation to...

  • catch committed 4fb83b5 on 8.3.x 
    Issue #2862752 by Jo Fitzgerald, phenaproxima: Add documentation to...
catch’s picture

catch
he/him
Primary language English
CreditAttribution: catch at Third and Grove commented
Status: Reviewed & tested by the community » Fixed

Committed/pushed to 8.4.x and 8.3.x, thanks!

Status: Fixed » Closed (fixed)

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