Problem/Motivation

Testing standards doc:
https://drupal.org/node/325974
is not in sync with #1906474: [policy adopted] Stop documenting methods with "Overrides …"

Proposed resolution

Testing standards doc:
https://drupal.org/node/325974
needs to be updated to remove the
"There is no PHPDoc on this function since it is an inherited method."
from both the setUp and getInfo and update the examples there to use {@inheritdoc}

Remaining tasks

verify this is reasonable
update the doc

User interface changes

No.

API changes

No.

Related

overall issue: #1869794: Update tests coding standards doc and make consistant with 1354 where appropriate

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented

Um. In Drupal 7.x, the setUp, tearDown, and getInfo methods actually did not exist on the base classes, so there was no documentation to inherit. So the standards for how to write test classes in 7.x should not change.

I'm not seeing those methods on WebTestBase in 8.x either, unless I missed something?

You can't use {@inheritdoc} unless there is documentation to inherit from a class or interface that the class is extending/implementing.

tim.plunkett’s picture

tim.plunkett
he/him
Primary language English
Location Philadelphia
CreditAttribution: tim.plunkett commented

This seems like a dupe of #338403: Use {@inheritdoc} on all class methods (including tests).

setUp() is on TestBase, and #1999512: getInfo() should be an abstract method with docs on TestBase/UnitTestCase will add getInfo().

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Active » Closed (duplicate)

Agreed this is a duplicate; will add comments to the other issue.