According to Drupal's documentation standards https://www.drupal.org/node/1354#throws , the comment for a throws directive is optional and only should be added if adds clarity to the use of an exception. Currently Drupal.Commenting.FunctionComment.EmptyThrows highlights the missing comment line as an error. This issue is to correct the false sniff for this condition.

This sniff condition was discovered while performing a code review for #2624640: Fixes to docs and code style for migrate/src/*.php files.

Comments

Lars Toomre created an issue. See original summary.

Lars Toomre’s picture

Lars Toomre CreditAttribution: Lars Toomre as a volunteer commented
Status: Needs review » Active

Whoops... wrong status.

klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
CreditAttribution: klausi commented
Issue summary: View changes

fixed link

  • klausi committed 384b79f on 8.x-2.x 
    Issue #2624648: Allow missing comment for @throws doc directive
klausi’s picture

klausi
he/him||they/them
Primary language German
Location 🇦🇹 Vienna
CreditAttribution: klausi commented
Status: Active » Fixed

Committed a fix, thanks for reporting!

Status: Fixed » Closed (fixed)

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