On the following files the file doc block is not correct.

CommentFileSizeAuthor
#13 interdiff.txt1.72 KBlaranajim
#13 2641092-13-wrong-file-doc.patch2.87 KBlaranajim
#11 2641092.11-wrong-file-doc.patch4.59 KBlaranajim
#10 2641092-10-wrong-file-doc.patch5.17 KBlaranajim

Comments

Chi created an issue. See original summary.

chi’s picture

chi commented
Title: Wrong file doc block on system kernel tests » Wrong file doc block on some tests
Issue summary: View changes
chi’s picture

chi commented
Issue summary: View changes
chi’s picture

chi commented
Issue summary: View changes

The following files contain more than one class. Not sure how to deal with such cases. Is it worth to list all classes in file the doc block?

chx’s picture

chx commented

Re #4 if PHP would have anonymous classes/interface these would be so. Not mentioning them is great -- nothing should know about them.

mimran’s picture

mimran commented
Assigned: Unassigned » mimran
chi’s picture

chi commented

if PHP would have anonymous classes

PHP7 does have anonymous classes. We may add respective TODO comments to those files.
http://php.net/manual/language.oop5.anonymous.php

mimran’s picture

mimran commented
Assigned: mimran » Unassigned
laranajim’s picture

laranajim commented
Assigned: Unassigned » laranajim
Issue tags: +CatalystAcademy
laranajim’s picture

laranajim commented
Assigned: laranajim » Unassigned
Status: Active » Needs review
StatusFileSize
new 2641092-10-wrong-file-doc.patch5.17 KB

Corrected file doc block. I added additional Contains to files with multiple classes. The Drupal documentation is not explicit when it comes to files with more than one class. As for the TODO with anonymous classes, can this be done as a follow-up issue?

laranajim’s picture

laranajim commented
StatusFileSize
new 2641092.11-wrong-file-doc.patch4.59 KB

Woops wrong patch file.

chx’s picture

chx commented

> I added additional Contains to files with multiple classes. The Drupal documentation is not explicit when it comes to files with more than one class.

It is not -- but I would like you to ask you to remove these. There are things which shouldn't be documented and these are such. They shouldn't exist and documenting them is just polluting the documentation.

laranajim’s picture

laranajim commented
StatusFileSize
new 2641092-13-wrong-file-doc.patch2.87 KB
new interdiff.txt1.72 KB

Thanks for the review @chx. I have implemented your suggestions.

chx’s picture

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

Looks great!

catch’s picture

catch
he/him
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Committed/pushed to 8.1.x and cherry-picked to 8.0.x. Thanks!

  • catch committed ea6f67e on 
    Issue #2641092 by laranajim: Wrong file doc block on some tests

Status: Fixed » Closed (fixed)

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