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

The protected methods in this trait all say 'inheritdoc' for their docs. But for a trait, that doesn't make sense. (Public methods on a trait at a push, because they often will be there to implement an interface that the consuming class implements.)

So these need to be documented here.

Furthermore, I can't find any method of the same name anywhere else in core.

CommentFileSizeAuthor
#4 documentation-8.8-missing-docs-2.patch1.08 KBiuana
#2 documentation-8.8-missing-docs-1.patch959 bytesiuana
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

joachim created an issue. See original summary.

iuana’s picture

iuana CreditAttribution: iuana at Softescu commented
Status: Active » Needs review
FileSize
documentation-8.8-missing-docs-1.patch959 bytes

Here is the patch, please review!
Thanks!

joachim’s picture

joachim CreditAttribution: joachim as a volunteer commented
Status: Needs review » Needs work

Thanks for the patch!

This is a good start, though:

+++ b/core/lib/Drupal/Core/Routing/LocalAwareRedirectResponseTrait.php
@@ -17,7 +17,10 @@
   protected function isLocal($url) {

This parameter needs to be documented.

iuana’s picture

iuana CreditAttribution: iuana at Softescu commented
FileSize
documentation-8.8-missing-docs-2.patch1.08 KB

Yep, I recreated.

iuana’s picture

iuana CreditAttribution: iuana at Softescu commented
Status: Needs work » Needs review
joachim’s picture

joachim CreditAttribution: joachim as a volunteer commented
Status: Needs review » Reviewed & tested by the community

Looks good. Thanks!

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Priority: Major » Normal
Status: Reviewed & tested by the community » Fixed

Committed and pushed 1eaf8e63e7 to 8.8.x and 2f73dd35de to 8.7.x. Thanks!

  • alexpott committed 1eaf8e6 on 8.8.x 
    Issue #3054392 by iuana, joachim: protected methods in...

  • alexpott committed 2f73dd3 on 8.7.x 
    Issue #3054392 by iuana, joachim: protected methods in...
alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott commented
Version: 8.8.x-dev » 8.7.x-dev

Status: Fixed » Closed (fixed)

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