example recipe.yml has invalid comment above "actions" section

Why is it invalid?

The comment above the actions section originally described a configuration related to user roles and permissions.

Original code:

# Configuration actions may be defined. The structure here should be
# entity_type.ID.action. Below the user role entity type with an ID of
# editor is having the permissions added. The permissions key will be
# mapped to the \Drupal\user\Entity\Role::grantPermission() method.
actions:
  user.role.editor:
    createIfNotExists:
      label: 'Editor'
    grantPermissions:
      - 'delete any article content'
      - 'edit any article content'

However, in a later commit, the actual configuration changed to modifying text.settings, but the comment remained unchanged:

actions:
  text.settings:
    simpleConfigUpdate:
      default_summary_length: 700

Now, the comment is misleading because it's still describing user roles and permissions, while the actual code is updating text summary length settings.

Have not reviewed

But should use complete issue summary.

Updated issue summary

This looks great. Thanks for the contribution!

@annmarysruthy, thanks for doing the research on how the example changed. When doing that important work it helps the others working on the issue to add links to the previous issues and/or commits.

Using git I found that the change happened in 🐛 Example recipe isn't functional Active . And skimming that issue it looks like an oversight that this comment was not updated as well.

quietone → closed merge request !11181

The new text was not wrapped correctly at 80. I fixed that on commit using a PHPStorm plugin that does the wrapping for me.

Committed to 11.x and cherry-pick to 11.1.x

Thanks!

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