Use "@return" instead of "@returns"

This was discussed in Slack by catch, larowlan, dww, bbrala, smustgrave and longwave. The consensus was that it is better to get this trival fix instead of waiting for the sniff. Also, as longwave pointed out that eventually all methods will have a return type so this will not be needed anyway.

To that end I chose to reroll the patch, yes staying with the patch workflow. Then I searched for for others instances and fixed those. Also, fixed any new errors caught php phpcs.

Searching for @returns and found a few more

believe the assets ones could be ignored.

@smustgrave: All but one of those "few more" are in .js files. JSDoc is different than PHPDoc (JSDoc allows use of @returns, among a lot of other things that are not allowed in PHPDoc) and JavaScript code is not included in the Drupal API documentation at api.drupal.org, which is what this issue was opened to fix.

The only one missed by the patch is in #24 is core/modules/jsonapi/tests/src/Kernel/ResourceType/ResourceTypeRepositoryTest.php

Here is a new patch that fixes that as well.

Hi,

I have reviewed patch #26, looks good to me.
It applied cleanly and replaced all the occurrences of @returns with @return at all places except the .js files in the core.
So, for me, it is RTBC.

Thanks & Regards,
Mrinalini

Thanks for pointing that out @TR

Committed c3ff576 and pushed to 11.x. Thanks!

It didn't cleanly backport to 10.1.x

One hunk of the patch in #26 does not apply in Drupal 10.1.x because a usage of @returns that was recently introduced only into 11.x by ✨ Make field selection less overwhelming by introducing groups Fixed . That code does not exist in 10.1.x, and therefore that hunk does not apply to 10.1.x.

Here is a version of #26 that applies in 10.1.x.

10.1 patch seems good.

Committed 7cbdf08 and pushed to 10.1.x. Thanks!

I realised that we previously banned @inheritDoc with a rule in phpcs.xml.dist; we can do the same for @returns: 📌 Prevent @returns from creeping back into the codebase Active

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