API page: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21EventSubs...

Enter a descriptive title (above) relating to class PathSubscriber, then describe the problem you have found:

The PathSubscriber class has only one line of documentation and it appears to have been copy/pasted from another class. It's totally wrong.

It needs to be replaced with a line documentation that says what it actually does, which is to translate path aliases.

I think this is actually a good novice project.

CommentFileSizeAuthor
#3 PathSubscriber-2105803-3.patch1.36 KBstephaneq
#1 PathSubscriber-2105803-1.patch570 bytesstephaneq

Comments

stephaneq’s picture

stephaneq
Primary language French
Location Paris 🇫🇷
commented
Status: Active » Needs review
StatusFileSize
new PathSubscriber-2105803-1.patch570 bytes

Here is a patch.

Should we fix the RedirectResponseSubscriber class in the same time, I think it's the same problem.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Thanks! Yes, let's fix both.

Also, a small grammatical problem: which -> that.

stephaneq’s picture

stephaneq
Primary language French
Location Paris 🇫🇷
commented
Status: Needs work » Needs review
StatusFileSize
new PathSubscriber-2105803-3.patch1.36 KB

I also changed the file docblock, should be "Contains" according to https://drupal.org/node/1354#file

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Title: PathSubscriber documentation is totally wrong » Subscriber class documentation is lacking in a couple of places

Looks good to me! Thanks for the extra doc fixes. In a small patch like this, they are always a welcome addition. Updating title. :)

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Fixed

Thanks again! Committed to 8.x.

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