Make documentation for typed things optional

Created on 24 May 2025, 13 days ago

Problem/Motivation

These coding standards are written for PHP4 not PHP8. Time to modernize.

Benefits

If we adopted this change, the Drupal Project would benefit by having significantly less boilerplate.

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

Everything that has a type doesn't require documentation. If a reviewer can't understand what's it for then add some. Otherwise, just stop. This was the original intent behind behind πŸ“Œ Allow omitting doxygen when type and variable name is enough Active anyways but even that limited version took two years. Now that Drupal has fully embraced typing even beyond what PHP can provide with ✨ Adopt phpstan phpdoc types as canonical reference of allowed types Active it's seriously time to stop doing this.

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 β†’

πŸ“Œ Task
Status

Active

Component

Coding Standards

Created by

πŸ‡¨πŸ‡¦Canada Charlie ChX Negyesi 🍁Canada

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

Comments & Activities

Production build 0.71.5 2024