Many .test files are missing their @file comment blocks, and others vary a bit in syntax.

Comments

jhodgdon’s picture

The .test files in general are not well documented -- many of the classes and methods in them do not conform to standards.

stephenh’s picture

StatusFileSize
new3.3 KB

I have reviewed core modules Aggregator through Forum and have attached a Patch that adds the missing @file comments to .test files.

jhodgdon’s picture

Status: Active » Needs review

You need to set issues to "needs review" when you attach a patch. That alerts people there's a patch to review, and launches the test bot too.

jhodgdon’s picture

Status: Needs review » Needs work

Review of this patch: it's not standardized -- you've used different wording for the @file comments. At least pick one. It's also best if you refer to a module as "whatever.module" as api.drupal.org will make that into a link.

stephenh’s picture

Status: Needs work » Needs review
StatusFileSize
new15.29 KB

Thanks for your feedback jhodgdon.

I remade the patch that adds/standardizes the missing @file comments to .test files for all core modules Aggregator through User, using the standard @file comment structure:

/**
 * @file
 * Tests for some.module.
 */ 
jhodgdon’s picture

Version: 8.x-dev » 7.x-dev

Changing the version to 7.x so the test bot will fire.

jhodgdon’s picture

Status: Needs review » Needs work

The patch looks fine to me, except that the chunk headers are:

diff --git a/modules/update/update.test b/modules/update/update.test
index 6cb4491..af0d873 100644
--- a/modules/update/update.test
+++ b/modules/update/update.test

I don't think the testbot is going to be able to apply the patch with the a/ and b/ prefix on the paths. Normally those a/ and b/ should be removed.

stephenh’s picture

Status: Needs work » Needs review
StatusFileSize
new14.97 KB

Re-applying patch with a/ and b/ prefixes removed from chunk header paths.

jhodgdon’s picture

Status: Needs review » Reviewed & tested by the community

Looks good, thanks!

The next step to fix up the .test files, if you are interested in continuing this work (on a separate issue probably), would be to make sure all the test classes and methods have a docblock header that meets our standards.

dries’s picture

Status: Reviewed & tested by the community » Fixed

Always good to be consistent. Committed to CVS HEAD.

Status: Fixed » Closed (fixed)

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