Problem/Motivation

Currently ModuleHandler contains a number of properties and parameters that only have an "array" doc without further specifity.

This is bad for static analysis (phpstan, IDEs) and when reading the code.
Developers who are familiar with advanced phpdoc/phpstan/psalm syntax don't want to read the textual explanations.

As a baseline for other issues that touch ModuleHandler, we can improve that documentation now.
This will also help when reviewing future merge requests.

Steps to reproduce

Proposed resolution

Add phpstan-like array docs.

See also #3468236: Adopt phpstan phpdoc types as canonical reference of allowed types.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

Issue fork drupal-3522788

Command icon Show commands

Start within a Git clone of the project using the version control instructions.

Or, if you do not have SSH keys set up on git.drupalcode.org:

About issue forks

Comments

donquixote created an issue. See original summary.

donquixote’s picture

donquixote commented
Issue summary: View changes
Related issues: +#3468236: Adopt phpstan phpdoc types as canonical reference of allowed types

donquixote opened merge request !12044

bbrala’s picture

bbrala
Location Netherlands
commented

Failure is unrelated, yay for build errors. Changes look good, al comply with the description of the variable. Its not NR, so cant do much more than this?

donquixote’s picture

donquixote commented
Status: Active » Needs review

Its not NR

sorry :)

bbrala’s picture

bbrala
Location Netherlands
commented
Status: Needs review » Reviewed & tested by the community

Ah thanks. Changes look good as i said earlier.

nicxvan’s picture

nicxvan commented
Component: base system » extension system

Just moving to the right component.

  • larowlan committed 85bb8ad1 on 11.x 
    Issue #3522788 by donquixote: Enhance array docs in ModuleHandler
larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Reviewed & tested by the community » Fixed

Committed to 11.x - thanks!

larowlan closed merge request !12044

donquixote’s picture

donquixote commented

Thanks!

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.