We need clearer, more detailed, and corrected/updated documentation pretty much everywhere.

-webchick

Basically all the SimpleTest API (non-test documentation needs to be cleaned-up, changed to fit new code, and completed)

The tests themselves could use commenting as well.

By commenting I mean documentation.

Files: 
CommentFileSizeAuthor
#7 simpletest_documentation.patch20.55 KBboombatower

Comments

birdmanx35’s picture

Let me know if there's any way I can help with this, even if it's just clean up and improving the writing.

birdmanx35’s picture

Title: Clean up documentaion » Clean up documentation
Assigned: Unassigned » birdmanx35

I guess I'm working on *cleaning up* now. I don't have enough time to improve it, per se, just clean it up. I'll unclaim this when I'm done.

birdmanx35’s picture

I did some major improvements on the main page, http://drupal.org/simpletest, and a little brushing up on the others. I'm unassigning this now, because I can't vastly improve them. I did a bit of clean up though, hopefully that will help.

birdmanx35’s picture

Assigned: birdmanx35 » Unassigned
birdmanx35’s picture

Fixed the main page up, amongst other things. Still a lot of room for improvement, but the dust is off the table.

boombatower’s picture

Looks like you fixed it up a bit. Thanks.

This was mainly intended to be API Documentation, but as I mentioned in chat we need that done too.

boombatower’s picture

Assigned: Unassigned » boombatower
Status: Active » Needs review
FileSize
20.55 KB

I have cleaned up the documentation on the DrupalTestCase. The other SimpleTest base files need to be cleaned up as well.

boombatower’s picture

Committed above patch.

Work still needs to be done on other files, although not as important.

boombatower’s picture

Status: Needs review » Fixed

This is somewhat outdated.

Anonymous’s picture

Status: Fixed » Closed (fixed)

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