Problem/Motivation

The documentation for \Drupal\config_collection_install_test\EventSubscriber::addCollections is outdated/wrong. It refers to ConfigEvents::COLLECTION_NAMES which doesn't exist, but uses ConfigEvents::COLLECTION_INFO

User interface changes

None

API changes

None

Data model changes

None

CommentFileSizeAuthor
#2 outdated_documentation-2643280-2.patch940 bytesgoogletorp
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

googletorp created an issue. See original summary.

googletorp’s picture

googletorp CreditAttribution: googletorp as a volunteer and at Reveal IT commented
Status: Active » Needs review
FileSize
outdated_documentation-2643280-2.patch940 bytes
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon at Poplar ProductivityWare for Drupal Association commented
Status: Needs review » Reviewed & tested by the community

Looks reasonable to me -- thanks for the issue and patch!

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Chapter Three commented
Title: Outdated documentation for \Drupal\config_collection_install_test\EventSubscriber::addCollections » Fix outdated documentation for ConfigEvents::COLLECTION_NAMES
Status: Reviewed & tested by the community » Needs work 
abstract class ConfigFactoryOverrideBase implements EventSubscriberInterface {

  /**
   * Reacts to the ConfigEvents::COLLECTION_INFO event.
   *
   * @param \Drupal\Core\Config\ConfigCollectionInfo $collection_info
   *   The configuration collection names event.
   */
  abstract public function addCollections(ConfigCollectionInfo $collection_info);

We should fix the @param doc here too to make core consistent. See https://www.drupal.org/core/scope

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Chapter Three commented
Status: Needs work » Reviewed & tested by the community

Actaully as it is a one word fix - decided to do this on commit.

alexpott’s picture

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

Committed 837d5a0 and pushed to 8.0.x and 8.1.x. Thanks!

  • alexpott committed a2e9644 on 8.1.x 
    Issue #2643280 by googletorp, alexpott: Fix outdated documentation for...

Status: Fixed » Closed (fixed)

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