Incorrect docs for constructor param in Plugin attribute class

I'm working on this at DrupalCon Barcelona 2024.

I'm mentoring Emily at Barcelona.

Randy Fay (rfay) has also helped.

Merge request created, needs review.

I'm working on this issue #barcelona2024

The text change looks correct to me.
It still needs technical review.

> + * The attribute plugin ID.

This should not say 'attribute'.

The attribute is a class that is used to define the plugin's metadata. The values passed to the attribute constructor's parameters will be about the plugin, not the attribute.

Removed "attribute."

Perfect! Thanks!

Thanks for working on this issue!

One thing we need to check before we commit this is that the merge request passes the test suite. You can see in the issue summary that the test suite has failed with the little red x in a circle:

I clicked on the red X to review the tests, to take me to this page, and navigated to the Nightwatch test that failed: https://git.drupalcode.org/issue/drupal-3476226/-/jobs/2873651

Here is the section that failed:

  ️TEST FAILURE (4m 26s):  
   - 1 assertions failed; 1425 passed
   ✖ 1) Olivero/oliveroMobileMenuTest
   – Verify mobile menu works when Big Pipe when authenticated (14.162s)
   → ✖ NightwatchAssertError
   Timed out while waiting for element <form.system-modules [name="modules[big_pipe][enable]"]:disabled> to be present for 10000 milliseconds. - expected "found" but got: "not found" (10176ms)
    Error location:
    /builds/issue/drupal-3476226/core/tests/Drupal/Nightwatch/Commands/drupalInstallModule.js:39
    –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
     37 |     // Wait for the checkbox for the module to be disabled as a sign that the
     38 |     // module has been enabled.
     39 |     this.waitForElementPresent( 
     40 |       `form.system-modules [name="modules[${module}][enable]"]:disabled`,
     41 |       10000,
    –––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––––
 Wrote HTML report file to: /builds/issue/drupal-3476226/nightwatch_output/nightwatch-html-report/index.html

As this is a JavaScript test, and the change is to documentation, it is very unlikely the change caused the failure.

I am rerunning the failed test to verify.

There was also a functional test failure:

This is a link to the failed test run log: https://git.drupalcode.org/issue/drupal-3476226/-/jobs/2873642

There was 1 failure:
1) Drupal\Tests\block\Functional\BlockCacheTest::testCachePermissions
Behat\Mink\Exception\ResponseTextException: The text "k1dabd5n" was not
found anywhere in the text of the current page.
/builds/issue/drupal-3476226/vendor/behat/mink/src/WebAssert.php:907
/builds/issue/drupal-3476226/vendor/behat/mink/src/WebAssert.php:293
/builds/issue/drupal-3476226/core/tests/Drupal/Tests/WebAssert.php:979
/builds/issue/drupal-3476226/core/modules/block/tests/src/Functional/BlockCacheTest.php:157
FAILURES!
Tests: 5, Assertions: 80, Failures: 1.

I searched the Drupal Core issue log, and it appears related to this issue:

https://www.drupal.org/project/drupal/issues/3468830 📌 [random test failure] BlockCacheTest Active

As this is clearly not caused by this change, I am also rerunning this test.

Adding 📌 [random test failure] BlockCacheTest Active as related issue.

I think that as this MR is a docs change only, we can be certain that the test failures are unconnected.

Tests passed on rerun.

Oops, cross posted, seems to have accidentally changed status. Setting back to RTBC.

Congratulations on getting this to RTBC!

Committed to 11.x and to 10.4.x. Thanks!

quietone → closed merge request !9625

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