Convert code blocks in comments using array() syntax to @code/@endcode

Created on 12 June 2024, 13 days ago
Updated 17 June 2024, 8 days ago

Problem/Motivation

Followup from πŸ“Œ Fix Drupal.Commenting.DocCommentLongArraySyntax coding standard Needs work .

This is to fix usages of array() in comments that can be converted to using @code/@endcode. These are not discovered by the sniff. The sniff only detects array() in code and in side @code/@endcode blocks.

Instances can be found by applying the diff from πŸ“Œ Fix Drupal.Commenting.DocCommentLongArraySyntax coding standard Needs work and then using the following grep.

grep -r "\barray(" * | grep -F \* | grep -v "vendor" | grep -v "node_modules"

This will find more instances than are being fixed here. The ones not done here are in sentences where an @code/@endcode in not the right choice.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

πŸ“Œ Task
Status

Needs work

Version

11.0 πŸ”₯

Component
OtherΒ  β†’

Last updated 34 minutes ago

Created by

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

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

Merge Requests

Comments & Activities

Production build 0.69.0 2024