Problem/Motivation

The changes required for 'Drupal.Commenting.DocComment.ShortSingleLine' are too large and need to be split into child issues.

Proposed resolution

Fix class doc block in non test files for the sniff 'Drupal.Commenting.DocComment.ShortSingleLine'.

Remaining tasks

Patch
Review - Instructions for adding the sniff and running the test are in the Issue Summary of #3123060: Enable 'Drupal.Commenting.DocComment.ShortSingleLine' coding standard
Commit

User interface changes

API changes

Data model changes

Release notes snippet

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

quietone created an issue. See original summary.

quietone’s picture

Status: Active » Needs review
FileSize
30.5 KB
Shashwat Purav’s picture

The patch in #2 applied successfully to 10.0.x branch.

quietone’s picture

Status: Needs review » Needs work
Issue tags: +Needs reroll

Time for a reroll

ravi.shankar’s picture

Status: Needs work » Needs review
Issue tags: -Needs reroll
FileSize
27.22 KB
8.78 KB

Added reroll of patch #2 on Drupal 10.0.x.

Removed needs reroll tag as well.

smustgrave’s picture

Version: 10.0.x-dev » 10.1.x-dev
Status: Needs review » Reviewed & tested by the community

Brought this up on slack and since this still cleanly applies to 10.1 good to mark RTBC.

If any additional work is needed I will help keep an eye out for any tweaks needed.

alexpott’s picture

Version: 10.1.x-dev » 9.4.x-dev
Status: Reviewed & tested by the community » Fixed

Committed and pushed eec3210128 to 10.1.x and f8144f44e2 to 10.0.x and 98b21491b4 to 9.5.x and c9f75473d4 to 9.4.x. Thanks!

Backported to 9.4.x as this is only minimal docs changes.

  • alexpott committed eec3210 on 10.1.x
    Issue #3268818 by ravi.shankar, quietone: Fix class comment doc blocks...

  • alexpott committed f8144f4 on 10.0.x
    Issue #3268818 by ravi.shankar, quietone: Fix class comment doc blocks...

  • alexpott committed 98b2149 on 9.5.x
    Issue #3268818 by ravi.shankar, quietone: Fix class comment doc blocks...

  • alexpott committed c9f7547 on 9.4.x
    Issue #3268818 by ravi.shankar, quietone: Fix class comment doc blocks...

Status: Fixed » Closed (fixed)

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