[meta] Fix 'Drupal.Commenting.DocComment.MissingShort' coding standard

Created on 28 March 2020, over 4 years ago
Updated 28 July 2024, about 1 month ago

Problem/Motivation

Enable 'Drupal.Commenting.DocComment.MissingShort' coding standard.

Proposed resolution

Step 1: Remove the following line from core/phpcs.xml.dist and run composer run phpcs -- -p to get the report of what to be fixed. Also you can checkout https://www.drupal.org/pift-ci-job/1631109 β†’ from #4

<exclude name="Drupal.Commenting.DocComment.MissingShort"/>

Step 2: Fix all of them manually, as this one CAN NOT be fixed by phpcbf automatically.

Remaining tasks

Implement for

User interface changes

API changes

Data model changes

Release notes snippet

πŸ“Œ Task
Status

Active

Version

11.0 πŸ”₯

Component
OtherΒ  β†’

Last updated about 7 hours 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.

  • πŸ‡ΊπŸ‡ΈUnited States scottatdrake

    I started looking at this issue at #drupalconPortland2024. My understanding of the blocker here is that adding comments for 1,300+ classes in the format "Class [class name]" is not valuable, and there are too many to write manually. In fact, I think there may be a PHPStan rule prohibiting repeating the class name in the comment, though I'd need to verify that claim.

    A couple of years have passed since this ticket was last updated. Now, we have LLM's like ChatGPT which can be pretty good at summarizing code. My idea is to write a script of some sort that passes the work of writing a meaningful description to one of them.

    Reviewing such a large MR will still be a challenge but we may be able to automate the writing portion.

    I'll wait for feedback before pursing this approach further.

  • πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand
  • πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand

    There are too many changes here and they will require some thought to decide on a correct summary line, so making this a meta.

Production build 0.71.5 2024