The Drupal 8 coding standard guide states

The @file doc block MUST be present for all PHP files, with one exception: files that contain a namespaced class/interface/trait, whose file name is the class name with a .php extension, and whose file path is closely related to the namespace (under PSR-4 or a similar standard), SHOULD NOT have a @file documentation block.

There were a few violations of this rule.

CommentFileSizeAuthor
#5 2742877-5.patch9.45 KBandypost
#5 interdiff.txt6.83 KBandypost
#4 2742877-4.patch3.31 KBandypost
#4 interdiff.txt700 bytesandypost
#2 2742877.patch3.3 KBimalabya

Comments

malavya created an issue. See original summary.

imalabya’s picture

imalabya
Primary language English
Location Bangalore
commented
StatusFileSize
new 2742877.patch3.3 KB

Adding a patch

imalabya’s picture

imalabya
Primary language English
Location Bangalore
commented
Status: Active » Needs review
andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Needs review » Reviewed & tested by the community
StatusFileSize
new interdiff.txt700 bytes
new 2742877-4.patch3.31 KB

Once we touch all files, better to fix 2 more nits

andypost’s picture

andypost
he/him
Primary language Russian
commented
Status: Reviewed & tested by the community » Needs review
StatusFileSize
new interdiff.txt6.83 KB
new 2742877-5.patch9.45 KB

Fix remains to conform Drupal coding standards

~/.composer/vendor/bin/phpcs -p --standard=Drupal --extensions=php,module,inc,install,test,profile,theme .

contact_storage$ phpcs .
................

Time: 1.96 secs; Memory: 11.5Mb
naveenvalecha’s picture

naveenvalecha
He/Him
commented
Title: Remove @file doc from Namespaced classes, interfaces and traits » Fixe drupal coding standards
Status: Needs review » Reviewed & tested by the community

title of the issue needs updation as it its fixing the code as per latest standards.
How about this ?
Rest looks good to go.

naveenvalecha’s picture

naveenvalecha
He/Him
commented
Title: Fixe drupal coding standards » Fix coding standard errors
larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
commented
Status: Reviewed & tested by the community » Fixed

thanks

  • larowlan committed 3615294 on 8.x-1.x authored by andypost 
    Issue #2742877 by andypost, malavya: Fix coding standard errors

Status: Fixed » Closed (fixed)

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