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

> whereas contained field items must implement the FieldItemInterface

This should be a full class name, so api.d.o creates a link.

CommentFileSizeAuthor
#6 2819479-6.patch596 bytesshashikant_chauhan
#2 2819479-2.patch707 bytesshashikant_chauhan

Comments

joachim created an issue. See original summary.

shashikant_chauhan’s picture

shashikant_chauhan commented
Status: Active » Needs review
StatusFileSize
new 2819479-2.patch707 bytes

adding patch.

joachim’s picture

joachim commented
Status: Needs review » Reviewed & tested by the community

Perfect! Thanks!

cilefen’s picture

cilefen commented
Title: fully qualify class name in docs so it links » Fully qualify the FieldItemListInterface class name in its docs so it links
alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Needs work

This should be adding an @see to the class instead of changing the comment.

shashikant_chauhan’s picture

shashikant_chauhan commented
Status: Needs work » Needs review
StatusFileSize
new 2819479-6.patch596 bytes

added @see to class.

joachim’s picture

joachim commented
Status: Needs review » Reviewed & tested by the community

Our docs are a mixture of both styles, and the standards don't say which is right, so fair enough.

alexpott’s picture

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

Committed and pushed e0463d0 to 8.3.x and 2718176 to 8.2.x. Thanks!

@joachim yep our docs are a mix but adding the @see means that IDEs will also link it and make it clickable whilst just putting it in the comment that does not work. Plus sometimes the fully qualified class name is longer than 80 characters so doing it this way fixes that too. Plus I find the comment more readable by humans :)

  • alexpott committed e0463d0 on 8.3.x 
    Issue #2819479 by shashikant_chauhan, joachim: Fully qualify the...

  • alexpott committed 2718176 on 8.2.x 
    Issue #2819479 by shashikant_chauhan, joachim: Fully qualify the...

Status: Fixed » Closed (fixed)

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