Add API documentation.

See the documentation in the process plugins for format examples.

CommentFileSizeAuthor
#8 interdiff-2862746-4-8.txt772 bytesmasipila
#8 2862746-8.patch1.99 KBmasipila
#4 2862746-4.patch1.98 KBmasipila
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

quietone created an issue. See original summary.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.0-alpha1 will be released the week of July 31, 2017, which means new developments and disruptive changes should now be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

masipila’s picture

masipila CreditAttribution: masipila as a volunteer commented
Assigned: Unassigned » masipila
masipila’s picture

masipila CreditAttribution: masipila as a volunteer commented
Assigned: masipila » Unassigned
Status: Active » Needs review
Issue tags: +API Documentation
FileSize
2862746-4.patch1.98 KB

Patch attached.

I'll write a FieldInstance pair for this probably tomorrow, #2862745: Add documentation to EntityFieldInstance destination plugin

phenaproxima’s picture

phenaproxima
he/him
Primary language English
Location Massachusetts
CreditAttribution: phenaproxima at Acquia commented
Status: Needs review » Needs work

Looks good. Only a couple of things:

  1. +++ b/core/modules/migrate/src/Plugin/migrate/destination/EntityFieldStorageConfig.php
@@ -3,7 +3,48 @@
+ * Provides destination plugin for FieldStorage configuration entities.

    Can we replace "FieldStorage configuration" with "field_storage_config"? 

  2. +++ b/core/modules/migrate/src/Plugin/migrate/destination/EntityFieldStorageConfig.php
@@ -3,7 +3,48 @@
+ * simplicity.
+ * @code

    Nit: Can there be an extra blank line before @code?

masipila’s picture

masipila CreditAttribution: masipila as a volunteer commented

Hi, thanks for a super fast review!

1. Of course we can but why would we want to? The name of the config entity this plugin is creating is FieldStorage... I can change this of course as suggested but I would like to understand the rationale...

2. Not according to the API documentation coding standards. The paragraph explaining the code must not have a linebreak between the paragraph and @code/@endcode.

Cheers,
Markus

masipila’s picture

masipila CreditAttribution: masipila as a volunteer commented
Status: Needs work » Needs review
Related issues: +#2862745: Add documentation to EntityFieldInstance destination plugin
masipila’s picture

masipila CreditAttribution: masipila as a volunteer commented
FileSize
2862746-8.patch1.99 KB
interdiff-2862746-4-8.txt772 bytes

We discussed #5.1 in IRC with @phenaproxima and the rationale of using field_storage_config instead of FieldStorage is that field_storage_config is the ID of the config entity type.

quietone’s picture

quietone CreditAttribution: quietone as a volunteer commented
Status: Needs review » Reviewed & tested by the community

The points in #5 have been address and I have none of my own. This is good to go!

Gábor Hojtsy’s picture

Gábor Hojtsy
he/him
Primary language Hungarian
Location Hungary
CreditAttribution: Gábor Hojtsy at Acquia commented

  • Gábor Hojtsy committed 8859f62 on 8.5.x 
    Issue #2862746 by masipila, quietone, phenaproxima: Add documentation to...

  • Gábor Hojtsy committed 06f336d on 8.4.x 
    Issue #2862746 by masipila, quietone, phenaproxima: Add documentation to...
Gábor Hojtsy’s picture

Gábor Hojtsy
he/him
Primary language Hungarian
Location Hungary
CreditAttribution: Gábor Hojtsy at Acquia commented
Version: 8.5.x-dev » 8.4.x-dev
Status: Reviewed & tested by the community » Fixed

Looks great, thanks!

Status: Fixed » Closed (fixed)

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