Contrib.social

Improve documentation of AttachmentsInterface methods

Open on Drupal.org →
Created on 30 May 2024, 26 days ago
Updated 13 June 2024, 11 days ago

Problem/Motivation

Drupal\Core\Render\AttachmentsInterface is basically as bad as the legendary ContextInterface was "interface for context".
It doesn't document what is in the $attachments array neither does it elaborate on the difference between set() and add().

Steps to reproduce

Open AttachmentsInterface . Try to figure it out what it does. Try to figure out the difference between set and add.

Proposed resolution

Move AttachmentsResponseProcessorInterface::processAttachments() doxygen into the AttachmentsInterface class doxygen . After that, refer to the class doxygen in every method doxygen and processAttachments() too. Explain set vs add on top.

Remaining tasks

Do it.

User interface changes

Not relevant.

API changes

Not relevant.

Data model changes

Not relevant.

Release notes snippet

Not relevant.

📌 Task
Status

Needs review

Version

11.0 🔥

Component
Base  →

Last updated about 2 hours ago

Created by

🇨🇦Canada Charlie ChX Negyesi 🍁Canada

Live updates comments and jobs are added and updated live.
  • Documentation

    Primarily changes documentation, not code. For Drupal core issues, select the Documentation component instead of using this tag. In general, component selection is preferred over tag selection.

  • Needs documentation

    A documentation change is requested elsewhere. For Drupal core (and possibly other projects), once the change has been committed, this status should be recorded in a change record node.

Sign in to follow issues

Merge Requests

Comments & Activities

contrib.social Blog FAQ Discussions
Production build 0.69.0 2024