Correct $suggestions documentation in hook_theme_suggestions_alter()

Seems simple enough

  * node and taxonomy term templates based on the user being logged in.
+ *
  * @code

May be out of scope but I think it reads better now.

This looks good, thanks.

+++ b/core/lib/Drupal/Core/Render/theme.api.php
@@ -694,8 +695,9 @@ function hook_theme_suggestions_HOOK(array $variables) {
+ * @param array &$suggestions

I was going to push back that we don't put the ampersand on parameter documentation, but it looks like we do in a few places. (Nowhere near the number of places we use pass-by-reference.) There's a followup in there to standardize that, but out of scope for this issue.

I tried to commit this, but am getting a weird error from PHPStan:

Running PHPStan on changed files.

 [ERROR] No files found to analyse.                                             


PHPStan: failed

The Needs Review Queue Bot → tested this issue.

While you are making the above changes, we recommend that you convert this patch to a merge request → . Merge requests are preferred over patches. Be sure to hide the old patch files as well. (Converting an issue to a merge request without other contributions to the issue will not receive credit.)

Yes yes, thanks bot. The RTBC is fine so long as I can figure out what's happening with PHPStan. 😂 I don't want to skip commit checks without knowing why it's failing.

Per @quietone:

It seems to occur when the file name is like "api.php" and only 1 file is changed.

Looks like a phpstan problem when a single file is to be scanned. Using phpstan inside ddev it fails with any one api.php file but if another file is on the command line it works. It does successfully find a single file when it is theme.ap.php or theme.a.php.
And adding api.php to the fileExtensions had no effect.

Since QA passed, given that info, I think it's safe to commit this with --no-commit-check for now. That said, we should file a core issue for this since it seems like a bug in the local commit check script.

Committed to 11.x, 10.2.x, and 10.1.x as a backportable API documentation fix. Thanks!

Follow up made, 🐛 phpstan fails for a single file ending with 'api.php' Active

Oops, still one other for the ampersand thing.

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

Made the followup in Coding Standards project. #3405434: Should the '&' be included in @param for variables passed by reference →