incorrect class docs for ModifyDestinationEvent

Created on 9 January 2024, 11 months ago
Updated 11 January 2024, 11 months ago

Problem/Motivation

The class docs say:

> * Allows modules to modify the HTML of a static page before save.

which is incorrect - they've been mistakenly copied from ModifyHtmlEvent.

Steps to reproduce

Proposed resolution

Remaining tasks

User interface changes

API changes

Data model changes

🐛 Bug report
Status

RTBC

Version

1.0

Component

Tome Static

Created by

🇬🇧United Kingdom joachim

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

Sign in to follow issues

Comments & Activities

  • Issue created by @joachim
  • First commit to issue fork.
  • Status changed to Needs review 11 months ago
  • Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update 11 months ago
    Waiting for branch to pass
  • 🇮🇳India viren18febS

    I have modified the doc comment and added a patch for this.

  • Status changed to Needs work 11 months ago
  • 🇬🇧United Kingdom joachim

    Thanks for the patch!

    1. +++ b/modules/tome_static/src/Event/ModifyDestinationEvent.php
      @@ -5,7 +5,9 @@ namespace Drupal\tome_static\Event;
      + * Defines the ModifyDestinationEvent class.
      

      We don't need this line, it just repeats the class name.

    2. +++ b/modules/tome_static/src/Event/ModifyDestinationEvent.php
      @@ -5,7 +5,9 @@ namespace Drupal\tome_static\Event;
      + * Allows modules to provide the opportunity to get and set the destination path.
      

      This is a good start, but it goes over the line limit.

      We can shorten it easily though - we don't need to say 'provide the opportunity'.

      So something like:

      'Allows modules to change the destination path of a static path.'

  • Status changed to Needs review 11 months ago
  • Open on Drupal.org →
    Core: 9.5.x + Environment: PHP 7.3 & MySQL 5.7
    last update 11 months ago
    Waiting for branch to pass
  • 🇮🇳India viren18febS

    I have updated the patch , please review
    Thanks

  • Status changed to RTBC 11 months ago
  • 🇬🇧United Kingdom joachim

    Looks great, thanks!

Production build 0.71.5 2024