Problem/Motivation

The final argument for \Drupal\image\Plugin\Field\FieldFormatter\ImageFormatter::__construct() is $image_style_storage, but this is missing from the constructor's docblock.

Proposed resolution

Add the missing @param declaration.

Remaining tasks

write patch. DONE.

User interface changes

none.

API changes

none.

Data model changes

none.

CommentFileSizeAuthor
#2 document-imageformatter-constructor-2844213-2.patch1.04 KBandrewmacpherson
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

andrewmacpherson created an issue. See original summary.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented
Issue summary: View changes
FileSize
document-imageformatter-constructor-2844213-2.patch1.04 KB
andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented
Status: Active » Needs review

I looked for other examples of EntityStorageInterface used in @param declarations, and copied the general style: "The [entity_type] storage."

Status: Needs review » Needs work

The last submitted patch, 2: document-imageformatter-constructor-2844213-2.patch, failed testing.

andrewmacpherson’s picture

andrewmacpherson CreditAttribution: andrewmacpherson as a volunteer and at Annertech commented
Status: Needs work » Needs review
tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
CreditAttribution: tstoeckler at bio.logis Genetic Information Management GmbH commented
Status: Needs review » Reviewed & tested by the community

Thanks, looks good to me!

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.3.x, thanks!

  • catch committed 80ffa8c on 8.3.x 
    Issue #2844213 by andrewmacpherson: Undocumented $image_style_storage...

  • catch committed 80ffa8c on 8.4.x 
    Issue #2844213 by andrewmacpherson: Undocumented $image_style_storage...

  • catch committed 80ffa8c on 8.4.x 
    Issue #2844213 by andrewmacpherson: Undocumented $image_style_storage...

Status: Fixed » Closed (fixed)

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