Enhance array docs in ModuleHandler

Created on 5 May 2025, 9 days ago

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.

Remaining tasks

User interface changes

Introduced terminology

API changes

Data model changes

Release notes snippet

📌 Task

Status

Active

Version

11.0 🔥

Component

base system

Created by

🇩🇪Germany donquixote

Live updates comments and jobs are added and updated live.

Merge Requests

!12044Enhance array docs in ModuleHandler
Open
🇩🇪Germany donquixote
updated 8 days ago

Comments & Activities

Issue created by @donquixote
Comment 9 days ago →
🇩🇪Germany donquixote
Merge request !12044Add array shape docs in ModuleHandler and some related files. → (Open) created by donquixote
Pipeline finished with Failed
9 days ago
Total: 589s
#489695
Comment 8 days ago →
🇳🇱Netherlands bbrala Netherlands
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?
Comment 8 days ago →
🇩🇪Germany donquixote
Its not NR

sorry :)
Comment 8 days ago →
🇳🇱Netherlands bbrala Netherlands
Ah thanks. Changes look good as i said earlier.

contrib.social Blog FAQ Discussions

Production build 0.71.5 2024