I've just notices a systematic flaw in the @file description within the \Drupal\file\Plugin\field subdirectories.

All the errors are of the form 

- * Contains \Drupal\file\Plugin\field\formatter\FileFormatterBase.
+ * Contains \Drupal\file\Plugin\Field\FieldFormatter\FileFormatterBase.

is case your eyes missed it the first time "formatter" should be FieldFormatter, and field should be capitalized.

When looking for similar errors I see some issues which attempted to fix all the documentation errors in the file module in one go, they have the status
closed won't fix.. as they got so large they got bogged down and became understandably unreviewable...

I hope this is small and sweet to review.

CommentFileSizeAuthor
FieldFormatter-0.patch2.85 KBmartin107

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Thanks, these all look right to me!

BETA: Simple docs fix only, unfrozen.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Title: Incorrection @file comments in file module » Incorrect @file docs in file module
alexpott’s picture

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

Documentation is not frozen in beta. Committed a746c55 and pushed to 8.0.x. Thanks!

  • alexpott committed a746c55 on 8.0.x 
    Issue #2406069 by martin107: Incorrect @file docs in file module

Status: Fixed » Closed (fixed)

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