Problem/Motivation

This work on this sniff needs to be re-scoped into smaller child issues, per #3123060-54: Enable 'Drupal.Commenting.DocComment.ShortSingleLine' coding standard

Proposed resolution

Remaining tasks

  1. #3123060: Enable 'Drupal.Commenting.DocComment.ShortSingleLine' coding standard - The final issue to add the sniff and fix any new or missed errors.

The number of files was taken from the latest patch on the issues on 2022-10-04.

Done

  1. 100 files - #3268833: Fix method comments in tests for Drupal.Commenting.DocComment.ShortSingleLine
  2. 62 files - #3268835: Fix method comments in non tests for Drupal.Commenting.DocComment.ShortSingleLine
  3. 12 files - #3268838: Fix functions and test modules for Drupal.Commenting.DocComment.ShortSingleLine
  4. 42 files - #3268818: Fix class comment doc blocks in non tests 'Drupal.Commenting.DocComment.ShortSingleLine'
  5. #3268746: Fix missing newlines for 'Drupal.Commenting.DocComment.ShortSingleLine'
  6. #3268829: Fix class property comments for Drupal.Commenting.DocComment.ShortSingleLine
  7. #3269000: fix docblock of TestFieldWidgetMultiple::isApplicable
  8. 98 files - #3268809: Fix class comment doc blocks in tests for 'Drupal.Commenting.DocComment.ShortSingleLine'

User interface changes

API changes

Data model changes

Release notes snippet

Comments

quietone created an issue. See original summary.

quietone’s picture

quietone commented
Issue summary: View changes

Decided to split the work up by test files and non test files. Then in each group do the class comments and the methods in separate issues. There is a child for properties, one where only new lines are added and one for test modules and files (.inc, .module etc).

Hopefully this will make it easier to get through this piece of work.

xjm’s picture

xjm
she/her
Primary language English
commented
Issue summary: View changes

 

xjm’s picture

xjm
she/her
Primary language English
commented
Issue summary: View changes

 

quietone’s picture

quietone commented
Title: [meta] Fix 'Drupal.Commenting.DocComment.ShortSingleLine' » [meta] Fix Drupal.Commenting.DocComment.ShortSingleLine
Issue summary: View changes

Add another child.

longwave’s picture

longwave
he/him
Primary language English
Location UK
commented

Once we have fixed all tests we can add this to phpcs.xml.dist:

  <rule ref="Drupal.Commenting.DocComment.ShortSingleLine">
    <include-pattern>*Test.php</include-pattern>
  </rule>

I don't think it's possible for PHPCS to tell the difference between class and method docblocks.

quietone’s picture

quietone commented
Issue summary: View changes
quietone’s picture

quietone commented
Issue summary: View changes

1 more committed

spokje’s picture

spokje
Primary language Dutch
commented
Issue summary: View changes
quietone’s picture

quietone commented
Issue summary: View changes
quietone’s picture

quietone commented
Issue summary: View changes
longwave’s picture

longwave
he/him
Primary language English
Location UK
commented
Status: Active » Fixed

#3123060: Enable 'Drupal.Commenting.DocComment.ShortSingleLine' coding standard is committed and so this work is complete - thanks everyone!

Status: Fixed » Closed (fixed)

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