Not all comments in aggregator.test follow the Drupal doxygen formatting conventions. This is getting in the way of improvements to aggregator.test, let's fix it.

Most importantly

* There should not be pseudo type definitions like @param object $feed, but @param $feed
* The description of a @param should be in a new line indented by 2 characters and it should explain what the type of the parameter is.

An example of an incorrect format would be AggregatorTestCase::deleteFeed(). An example of a correct format would be AggregatorTestCase::createFeed().

Comments

alex_b’s picture

Issue tags: +Novice

This is a Novice task.

JamesAn’s picture

Status: Active » Needs review
StatusFileSize
new2.37 KB

I've combed through the comments and reformatted some of the comments to comply with the conventions. I think I've caught them all.

alex_b’s picture

Status: Needs review » Needs work

James - end all comments with a period (e. g. TRUE if feed is unique). Otherwise this looks great as far as I can tell.

JamesAn’s picture

Status: Needs work » Needs review
StatusFileSize
new2.43 KB

Thanks for catching that. Someone else told me that today too.. ^^" I'll remember it this time! That comment 'TRUE if feed is unique' appears to be the only comment without a terminating period.

alex_b’s picture

Status: Needs review » Reviewed & tested by the community
Issue tags: +Quick fix

Nice work. Ready to be committed.

Status: Reviewed & tested by the community » Needs work

The last submitted patch failed testing.

JamesAn’s picture

Status: Needs work » Needs review
StatusFileSize
new2.37 KB

Oops. Uploaded the wrong one.. without the period. Don't know why it failed though. Let's try again.. ^^"

JamesAn’s picture

I think the manual editting problem started after I finished working on #228477: Sinhala language in Drupal. I set my text editor to 16-bit Unicode encoding to deal with the Sinhala native characters and UTF-16-encoded patches don't seem to work. But it did with #228477. I don't know. Ah well.. At least it passes here.

dries’s picture

Status: Needs review » Fixed

Committed to CVS. Thanks.

Status: Fixed » Closed (fixed)
Issue tags: -Quick fix, -Novice

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