As per coding standard documentation at 'https://www.drupal.org/coding-standards/docs', @file tag docblock should not be there in the files that contain a namespaced class/interface/trait, whose file name is the class name with a .php extension.

CommentFileSizeAuthor
#8 2747243-4.patch8.5 KBrajeshwari10
#6 remove@file-2747243-6.patch10.62 KBneha.gangwar
#4 remove@file-2747243-4.patch10.94 KBneha.gangwar
#2 2747243-2.patch8.51 KBrajeshwari10
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

rajeshwari10 created an issue. See original summary.

rajeshwari10’s picture

rajeshwari10 CreditAttribution: rajeshwari10 as a volunteer and at Blisstering Solutions commented
Status: Active » Needs review
FileSize
2747243-2.patch8.51 KB

Removed @file doc block from all the .php files

Please review.

Thanks!!

naveenvalecha’s picture

naveenvalecha
He/Him
Primary language Hindi
CreditAttribution: naveenvalecha as a volunteer and at Acquia for Acquia commented
Category: Bug report » Task
Status: Needs review » Needs work
Issue tags: -Documentation +Novice

Thanks for the patch!

+++ b/src/Form/SettingsForm.php
@@ -1,11 +1,5 @@
- * Contains Drupal\votingapi\Form\SettingsForm.

only remove the contains here. let's remain the description about the file.

neha.gangwar’s picture

neha.gangwar CreditAttribution: neha.gangwar as a volunteer commented
Status: Needs work » Needs review
FileSize
remove@file-2747243-4.patch10.94 KB

Removed only the @file and contains. Remained the description on all files.

naveenvalecha’s picture

naveenvalecha
He/Him
Primary language Hindi
CreditAttribution: naveenvalecha as a volunteer and at Acquia for Acquia commented
Status: Needs review » Needs work 
+++ b/composer.json
@@ -10,5 +10,7 @@
-  "require": { }
+  "require": {
+    "drupal/votingapi": "8.x-3.0-alpha1"
+  } ¶

unrelated changes.

neha.gangwar’s picture

neha.gangwar CreditAttribution: neha.gangwar as a volunteer commented
Status: Needs work » Needs review
FileSize
remove@file-2747243-6.patch10.62 KB

Sorry my bad. Please consider this one

naveenvalecha’s picture

naveenvalecha
He/Him
Primary language Hindi
CreditAttribution: naveenvalecha as a volunteer and at Acquia for Acquia commented
Status: Needs review » Needs work

Thanks for the updates! few nitpicks needed

  1. +++ b/tests/modules/votingapi_test/votingapi_test.module
@@ -1,6 +1,5 @@
- * @file

    no need to remove the @file from here. It's also unrelated change. 

  2. +++ b/votingapi.api.php
@@ -1,7 +1,6 @@
- * @file

    same here.as above 

  3. +++ b/votingapi.drush.inc
@@ -1,7 +1,6 @@
- * @file

    same here. unrelated change. 

  4. +++ b/votingapi.install
@@ -1,7 +1,6 @@
- * @file

    same here. unrelated change. 

  5. +++ b/votingapi.module
@@ -1,9 +1,6 @@
- * @file
- * Contains votingapi.module.
- *

    same here. unrelated change.

rajeshwari10’s picture

rajeshwari10 CreditAttribution: rajeshwari10 as a volunteer and at Blisstering Solutions commented
Status: Needs work » Needs review
FileSize
2747243-4.patch8.5 KB

I have done changes as per said in #3.

naveenvalecha’s picture

naveenvalecha
He/Him
Primary language Hindi
CreditAttribution: naveenvalecha as a volunteer and at Acquia for Acquia commented
Status: Needs review » Reviewed & tested by the community

looks good. Thanks!

  • pifagor committed 5160279 on 8.x-3.x 
    Issue #2941917 by steveoliver: Missing config schema. Issue #2747243 by...
pifagor’s picture

pifagor
Location 🇺🇦 Rivne
CreditAttribution: pifagor as a volunteer and at Drupal Ukraine Community for Drupal Ukraine Community commented
Status: Reviewed & tested by the community » Fixed
pifagor’s picture

pifagor
Location 🇺🇦 Rivne
CreditAttribution: pifagor as a volunteer and at Drupal Ukraine Community for Drupal Ukraine Community commented
Status: Fixed » Closed (fixed)
rajeshwari10’s picture

rajeshwari10 CreditAttribution: rajeshwari10 as a volunteer and commented
Assigned: rajeshwari10 » Unassigned