Problem/Motivation

The docblock for ConfigDependencyManager uses a <code> tag instead of @code and @endcode, so the code snippet is not displayed properly at:
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Config%21...

Proposed resolution

Correct it to use @code and @endcode. See: https://www.drupal.org/node/1354#code

Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Issue category Bug because the docblock is not displayed correctly in API documentation.
Issue priority Minor because the actual content of the documentation is correct.
Unfrozen changes Unfrozen because it only changes documentation.
Disruption Not disruptive.

Remaining tasks

 

 

Contributor tasks needed
Task Novice task? Contributor instructions Complete?
Create a patch Instructions Done
Review patch to ensure that it fixes the issue, stays within scope, is properly documented, and follows coding standards Novice Instructions

User interface changes

None.

API changes

None.

CommentFileSizeAuthor
config-dependency-manager-code.patch858 bytesxjm
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

xjm’s picture

xjm
she/her
Primary language English
CreditAttribution: xjm commented
Issue summary: View changes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Reviewed & tested by the community

Doh! Good catch. Thanks!

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Status: Reviewed & tested by the community » Fixed

Committed 357003f and pushed to 8.0.x. Thanks!

  • alexpott committed 357003f on 8.0.x 
    Issue #2403571 by xjm: ConfigDependencyManager docblock uses HTML...

Status: Fixed » Closed (fixed)

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