Closed (fixed)
Project:
Drupal core
Version:
7.x-dev
Component:
documentation
Priority:
Normal
Category:
Task
Assigned:
Unassigned
Reporter:
Created:
8 Jan 2011 at 16:45 UTC
Updated:
18 Feb 2011 at 18:50 UTC
Jump to comment: Most recent file
Comments
Comment #1
jhodgdonThe .test files in general are not well documented -- many of the classes and methods in them do not conform to standards.
Comment #2
stephenh commentedI have reviewed core modules Aggregator through Forum and have attached a Patch that adds the missing @file comments to .test files.
Comment #3
jhodgdonYou 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.
Comment #4
jhodgdonReview 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.
Comment #5
stephenh commentedThanks 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:
Comment #6
jhodgdonChanging the version to 7.x so the test bot will fire.
Comment #7
jhodgdonThe patch looks fine to me, except that the chunk headers are:
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.
Comment #8
stephenh commentedRe-applying patch with a/ and b/ prefixes removed from chunk header paths.
Comment #9
jhodgdonLooks 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.
Comment #10
dries commentedAlways good to be consistent. Committed to CVS HEAD.