Hi,

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.

Check Documentation: API documentation and comment standards

Thanks

CommentFileSizeAuthor
#3 afterPatch_migrate_plus.png15.1 KBAanal.addweb
#2 migrate_plus-remove_wrong_doc-2877118-2-8x.patch903 bytesmgoncalves
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

mgoncalves created an issue. See original summary.

mgoncalves’s picture

mgoncalves CreditAttribution: mgoncalves at CI&T commented
Assigned: mgoncalves » Unassigned
Status: Active » Needs review
FileSize
migrate_plus-remove_wrong_doc-2877118-2-8x.patch903 bytes
Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented
Status: Needs review » Reviewed & tested by the community
FileSize
afterPatch_migrate_plus.png15.1 KB

@mgoncalves, Thanks for the patch & it works well as expected. I checked it manually by applying it in module file. PFA as result.

  • heddn committed aa7fd26 on 8.x-4.x authored by mgoncalves 
    Issue #2877118 by mgoncalves, dhwani.addweb: Remove @file documentation
heddn’s picture

heddn
Primary language English
Location Nicaragua
CreditAttribution: heddn at MTech, LLC commented
Status: Reviewed & tested by the community » Fixed

Applying a patch and making sure it doesn't fail is only part of reviewing a change like this. In fact, that part was already done by the testbot. Rather, I'd also like to see some verification that the patch abides by the docs requirements. And it catches all and only the requirements.

$  git grep '@file'
migrate_example/migrate_example_setup/migrate_example_setup.install: * @file
migrate_example_advanced/migrate_example_advanced.install: * @file
migrate_example_advanced/migrate_example_advanced_setup/migrate_example_advanced_setup.install: * @file
migrate_plus.install: * @file
migrate_plus.module: * @file

Seems good to me.

Lastly, for small things like this, I don't tend to hand out commit credit. This is a fairly trivial change and isn't adding a lot of value.

  • heddn committed 2b42751 on 8.x-3.x authored by mgoncalves 
    Issue #2877118 by mgoncalves, dhwani.addweb: Remove @file documentation

  • heddn committed 4138607 on 8.x-2.x authored by mgoncalves 
    Issue #2877118 by mgoncalves, dhwani.addweb: Remove @file documentation
mgoncalves’s picture

mgoncalves CreditAttribution: mgoncalves at CI&T commented

Hi @heddn

No problem about commit credits.
The most important is help the community !!!

Thank you

Aanal.addweb’s picture

Aanal.addweb CreditAttribution: Aanal.addweb at AddWeb Solution Pvt. Ltd. commented

@heddn, Thanks for committing, but i didn't get RTBC Credit for the same. Can you please do the needful?

Status: Fixed » Closed (fixed)

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