To meet coding standards this needs to be a full doc block or the 'Used ..' line removed.
/**
* {@inheritdoc}
* Used in \Drupal\field\Tests\EntityReference\EntityReferenceAdminTest::testAvailableFormatters().
*/
public static function isApplicable(FieldDefinitionInterface $field_definition) {
// Returns FALSE if machine name of the field equals field_onewidgetfield.
return $field_definition->getName() != "field_onewidgetfield";
}
| Comment | File | Size | Author |
|---|---|---|---|
| #9 | 3269000-9.patch | 1.29 KB | quietone |
| #9 | interdiff-6-9.txt | 1.16 KB | quietone |
| #7 | 3269000-6.patch | 1.18 KB | shashwat purav |
| #5 | 3269000-5.patch | 1.23 KB | longwave |
| #4 | 3269000.patch | 1010 bytes | longwave |
Comments
Comment #2
quietone commentedThere is only one testAvailableFormatters which is in ./core/modules/field/tests/src/Functional/EntityReference/EntityReferenceAdminTest.php. I ran that test with a breakpoint in isApplicable() and the breakpoint was never reached. Is this method used at all?
Comment #3
quietone commentedComment #4
longwaveThere's one way to find out.
field_onewidgetfield is referred to in two tests, core/modules/field_ui/tests/src/FunctionalJavascript/ManageDisplayTest.php and core/modules/field/tests/src/Kernel/WidgetPluginManagerTest.php.
If this patch passes, then I guess the code is safe to remove.
If the patch fails, I think we just drop the "Used in..." and leave @inheritdoc.
Comment #5
longwaveFix unused use statement.
Comment #7
shashwat purav commentedAdded patch to fix docblock of TestFieldWidgetMultiple::isApplicable.
Comment #9
quietone commentedThe new doc comment isn't adding anything, it is the same as the comment in the function. So, I looked at the WidgetPluginManager to get a better idea of what this is doing and then made a new comment. I also added an @see because of a comment Berdir made in the original issue that added this method, #2204325-20: The "rendered entity" formatter breaks for entity types with out a ViewBuilder.
Comment #10
longwaveLooks good to me.
Comment #11
alexpottCommitted and pushed 09672b4d3f to 10.1.x and a8a8904503 to 10.0.x and 70cd4ec217 to 9.5.x. Thanks!
Backported to 9.5.x as this is a docs only fix.