Fix 'Drupal.Commenting.DocComment.ClassMissingShort' in non tests

Created on 15 May 2020, over 4 years ago
Updated 28 July 2024, 5 months ago

Problem/Motivation

There are too many violations of 'Drupal.Commenting.DocComment.MissingShort' to complete in one issue. Fix non test files in this issue.

Proposed resolution

Add meaningful summary lines to fix violations of Drupal.Commenting.DocComment.MissingShort for non test files.

Remaining tasks

Add the following to phpcs.xml.dist

  <rule ref="Drupal.Commenting.DocComment.MissingShort">
    <exclude-pattern>*/tests/*</exclude-pattern>
  </rule>  

Run phpcs, add summary lines.
Review

User interface changes

API changes

Data model changes

Release notes snippet

📌 Task
Status

Active

Version

11.0 🔥

Component
Other 

Last updated 2 days ago

Created by

🇨🇳China jungle Chongqing, China

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • 🇳🇿New Zealand quietone

    Changing the scope here to implement the sniff for non tests. Today, 80 files were found so many that is a reasonable size to do here.
    Setting to active because this needs a new MR and #5.

Production build 0.71.5 2024