Contrib.social

Fix API docs for ConfigDependencyManager

Open on Drupal.org →
Created on 17 April 2021, about 4 years ago
Updated 1 February 2023, about 2 years ago

Problem/Motivation

While reviewing #2571235: [regression] Roles should depend on objects that are building the granted permissions → , I looked at the API docs for the ConfigDependencyManager class. I noticed that the docs did not describe the nested elements in the dependency array.

Comparing the doc block for the class to the API docs, it seems that the doxygen processor strips comments from otherwise empty arrays.

Steps to reproduce

Compare the code in core/lib/Drupal/Core/Config/Entity/ConfigDependencyManager.php, specifically the part in the @code block near the top, to the API docs.

Proposed resolution

Rewrite the doc block so that the comments are not stripped.

Remaining tasks

User interface changes

API changes

None

Data model changes

None

Release notes snippet

N/A

🐛 Bug report
Status

Needs work

Version

10.1 ✨

Component
Documentation  →

Last updated about 1 hour ago

No maintainer
Created by

🇺🇸United States benjifisher Boston area

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

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Comment about 2 years ago →
    🇺🇸United States smustgrave

    This issue is being reviewed by the kind folks in Slack, #needs-review-queue-initiative. We are working to keep the size of Needs Review queue [2700+ issues] to around 400 (1 month or less), following Review a patch or merge request → as a guide.

    FYI #11 still cleanly applied to D10.1.x

    @kkalashnikov you can check this locally or by clicking retest.

    Moving to NW for the feedback in #12

  • Comment about 2 years ago →
    🇮🇳India kkalashnikov Ghaziabad, India

    Hello @smustgrave,

    There is a change in #17 patch and this is the interdiff of these two patches.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024