Adopt phpstan phpdoc types as canonical reference of allowed types

Created on 15 August 2024, 8 months ago

Problem/Motivation

A number of issues have been rejected because a @param type has been too specific, for example @param array<string, string|false>.

Instead of maintaining a definition of what is a valid param type we should lean on the wider community and "get off the island".

I propose that anything included in https://phpstan.org/writing-php-code/phpdoc-types should be allowed.

Benefits

Allowing newer param types to be used without waiting for coding standards process

Three supporters required

  1. https://www.drupal.org/u/ โ†’ {userid} (yyyy-mm-dd they added support)
  2. https://www.drupal.org/u/ โ†’ {userid} (yyyy-mm-dd they added support)
  3. https://www.drupal.org/u/ โ†’ {userid} (yyyy-mm-dd they added support)

Proposed changes

Provide all proposed changes to the Drupal Coding standards โ†’ . Give a link to each section that will be changed, and show the current text and proposed text as in the following layout:

1. {link to the documentation heading that is to change}

Add current text in blockquotes

Add proposed text in blockquotes

2. Repeat the above for each page or sub-page that needs to be changed.

Remaining tasks

  1. Add supporters
  2. Create a Change Record
  3. Review by the Coding Standards Committee
  4. Coding Standards Committee takes action as required
  5. Discussed by the Core Committer Committee, if it impacts Drupal Core
  6. Final review by Coding Standards Committee
  7. Documentation updates
    1. Edit all pages
    2. Publish change record
    3. Remove 'Needs documentation edits' tag
  8. If applicable, create follow-up issues for PHPCS rules/sniffs changes

For a full explanation of these steps see the Coding Standards project page โ†’

โœจ Feature request
Status

Active

Component

Coding Standards

Created by

๐Ÿ‡ฆ๐Ÿ‡บAustralia mstrelan

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

Production build 0.71.5 2024