PyCon UK 2015

Unit test documentation improvements


I use the standard library Python unittest package. Various assertXXX methods take two arguments, one "expected" and one "actual". The documentation doesn't give any indication which is which, but the output produced assumes you knew. The sprint would be to work out the necessary changes to the documentation, determine if the module docstrings also needed changing, and perhaps whether the method arguments should/could be renamed, finishing with putting together a patch submission (or whatever the appropriate mechanism is). It could be a one person task, but would work better with two, to make sure the results make sense.