No documentation about @group @coversDefaultClass @covers

Created on 22 August 2014, about 10 years ago

Updated 23 July 2024, about 2 months ago

Problem/Motivation

Problem on API documentation and comment standards https://www.drupal.org/node/1354 → regarding

@coversDefaultClass
@covers
@group

Running either grep -r @coversDefaultClass core | grep -v vendor or grep -r '@covers ' core | grep -v vendor reveals we use these. Those seem to be the only two grep -r '@covers' core | grep -v vendor | grep -v "@covers " | grep -v @coversDefault currently in use.

See

Proposed resolution

Add documentation for this.

Remaining tasks

User interface changes

API changes

📌 Task

Status

Active

Component

Coding Standards

Created by

🇳🇱Netherlands clemens.tolboom Groningen, 🇳🇱/🇪🇺

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.

Incomplete comments

Comments & Activities

Not all content is available!

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

Comment 2 months ago →
🇳🇿New Zealand quietone New Zealand
Status changed to Active about 2 months ago3:50am 16 July 2024
Comment about 2 months ago →
🇳🇿New Zealand quietone New Zealand
Comment about 2 months ago →
🇳🇿New Zealand quietone New Zealand
At the recent coding standards meeting mstrelan reported that 'we need to use attributes' and not annotations. See the meeting issue for the full discussion, #3458726: Coding Standards Meeting Tuesday 2024-07-16 2100 UTC →

The suggestion was that our docs should point to PHPUnit docs. I currently disagree with that because of the '@group'. There is no documentation to explain how that is used in Drupal. Sometimes it is upper case and sometime it is not. That should be made clear to developers.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024