The comment before the ItemStorage class is the following one.

/**
 * Controller class for aggregators items.
 *
 * This extends the Drupal\Core\Entity\Sql\SqlContentEntityStorage class, adding
 * required special handling for feed item entities.
 */

That class isn't a controller class, but a storage handler class. That comment should be changed to the following one, which is similar to the comment used in NodeStorage.php.

/**
 * Defines the storage handler class for feed item entities.
 *
 * This extends the base storage class, adding required special handling for
 * feed item entities.
 */

I would replace aggregators items since it's not correct. (The appositive that precedes the referenced noun phrase is a singular noun phrase.) I would also avoid to make explicit which is the base class, as in this context isn't necessary. (Furthermore, the base class is already documented in the code, which is visible in the documentation page.)

The same happens in FeedStorage.php.

/**
 * Controller class for aggregator's feeds.
 *
 * This extends the Drupal\Core\Entity\Sql\SqlContentEntityStorage class, adding
 * required special handling for feed entities.
 */

In this case, I would change it to the following comment.

/**
 * Defines the storage handler class for feed entities.
 *
 * This extends the base storage class, adding required special handling for
 * feed entities.
 */
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

kiamlaluno created an issue. See original summary.

apaderno’s picture

Title: The comment for the ItemStorage class defines the class a controller, when it's a storage handler » The comments for the Aggregator storage classes define the classes controllers, when they are storage handlers
Issue summary: View changes
Issue tags: +Novice

The same error is not done for the interfaces implemented by those storage classes. For example, the comment for FeedStorageInterface says Defines an interface for aggregator feed entity storage classes..

apaderno’s picture

Status: Active » Needs review
FileSize
1.46 KB
bandanasharma’s picture

@kiamlaluno, patch is apply sucessfully. All the comment changes reflect in both files. +1 for the RTBC.

bandanasharma’s picture

Status: Needs review » Reviewed & tested by the community

  • catch committed 369277f on 9.1.x
    Issue #3168074 by kiamlaluno, bandanasharma: The comments for the...
catch’s picture

Status: Reviewed & tested by the community » Fixed

Committed 369277f and pushed to 9.1.x. Thanks!

Status: Fixed » Closed (fixed)

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