[docs] [issue19006] UnitTest docs should have a single list of assertions

Ezio Melotti report at bugs.python.org
Wed Sep 11 18:10:16 CEST 2013


Ezio Melotti added the comment:

> There's nothing fundamentally different about the two lists

I made that division because the ones in the first table are the most common and widely used, and are quite general too.
The second table contains assert methods about catching exceptions and warnings, and, while still common, they are different from the first group. 
The third table has additional assertions that are quite specific and not used too often, and many of these have been added later on.
There's also a fourth table with additional type-specific assertions, but they shouldn't be used directly.

Also note that the list of methods is different on 3.x, even though I kept the same division on all the branches.

> These should be merged into a single list.

Having a table with all the assert methods would indeed provide a better overview, but it would be quite a big table (25 assert methods on 3.4, excluding the type-specific ones) and might make navigation more difficult while scrolling through the methods.  Something could be done to make clear that there are other tables down below though (e.g. adding links or using sub-sections with an index).

----------
nosy: +ezio.melotti, michael.foord
type:  -> enhancement
versions: +Python 3.3, Python 3.4

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue19006>
_______________________________________


More information about the docs mailing list