Contrib.social

Remove the "For our Sandwich plugin type, we've specified the @cache.default service be used in the plugin_type_example.services.yml file." sentence from a code comment

Open on Drupal.org →
Created on 29 January 2020, about 5 years ago
Updated 14 July 2024, 9 months ago

The SandwichPluginManager.php file contains a code comment with the following sentence.

For our Sandwich plugin type, we've specified the @cache.default service be used in the plugin_type_example.services.yml file.

However, the plugin_type_example.services.yml file does not contain any line setting the cache.default service as argument, contrary to what that code comment makes think.

That sentence should be removed. The full comment should be the following one.

    // This sets the caching method for our plugin definitions. Plugin
    // definitions are discovered by examining the $subdir defined above, for
    // any classes with an $plugin_definition_annotation_name. The annotations
    // are read, and then the resulting data is cached using the provided cache
    // backend. The second argument is a cache key prefix. Out of the box Drupal
    // with the default cache backend setup will store our plugin definition in
    // the cache_default table using the sandwich_info key. All that is
    // implementation details, however; all we care about it is that caching for
    // our plugin definition is taken care of by this call.

Punctuation needs to be changed to avoid a comma-splice sentence. Furthermore, all we care about it that caching for our plugin definition is taken care of by this call must be changed to all we care about it is that caching for our plugin definition is taken care of by this call.

I would fix that in this issue, instead of opening a new issue.

📌 Task
Status

Fixed

Version

4.0

Component

Plugin Type Example

Created by

🇨🇦Canada alberto56

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

Merge Requests

Comments & Activities

Not all content is available!

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

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024