#42731 closed enhancement (fixed)
Add inline documentation to WP_UnitTestCase
Reported by: | Frank Klein | Owned by: | johnbillion |
---|---|---|---|
Milestone: | 5.1 | Priority: | normal |
Severity: | normal | Version: | |
Component: | Build/Test Tools | Keywords: | has-patch commit |
Focuses: | Cc: |
Description
The WP_UnitTestCase
class is large, and complex, but it does not contain much inline documentation to make it easier to understand.
Let's change that.
Attachments (2)
Change History (9)
#2
@
7 years ago
- Milestone changed from Awaiting Review to 5.0
Looking good Frank, a couple of things:
- Can you update the patch to so that "back ported" is spelled as one word, i.e "backported" please
- I think the
//error_log( $file );
comment should remain, it gives a quick heads up when debugging
#3
@
7 years ago
Thanks for the feedback, updated the patch.
Concerning the commented out //error_log( $file );
, I agree that this should not be removed in a patch that adds inline documentation.
However I am convinced that it should not remain in the file, it should just be removed as part of another ticket. Leaving commented out code behind is like leaving litter on the floor of a public place.
Note: See
TracTickets for help on using
tickets.
The patch above contains part one, as it's easier to do this in phases.