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

[Roundup Robot]

Roundup Robot added the comment:

New changeset ddb8fa84a119 by Ezio Melotti in branch '2.7':
#19006: fix wording in unittest docs.
https://hg.python.org/cpython/rev/ddb8fa84a119

New changeset 84f34e8685de by Ezio Melotti in branch '3.5':
#19006: fix wording in unittest docs.
https://hg.python.org/cpython/rev/84f34e8685de

New changeset 86c8d65d188f by Ezio Melotti in branch 'default':
#19006: merge with 3.5.
https://hg.python.org/cpython/rev/86c8d65d188f

--
nosy: +python-dev

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Ezio Melotti]

Ezio Melotti added the comment:

Fixed, thanks for the review!

--
resolution:  -> fixed
stage: commit review -> resolved
status: open -> closed

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Kushal Das]

Kushal Das added the comment:

The patch looks good to me. Commit :)

--

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Ezio Melotti]

Ezio Melotti added the comment:

Here's a patch.

--
assignee: docs@python -> ezio.melotti
keywords: +patch
stage:  -> commit review
versions: +Python 3.5, Python 3.6 -Python 3.3, Python 3.4
Added file: http://bugs.python.org/file41462/issue19006.diff

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Nicholas H.Tollervey]

Changes by Nicholas H.Tollervey :


--
nosy: +kushal.das, ntoll

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Arnon Yaari]

Changes by Arnon Yaari :


--
nosy: +wiggin15

___
Python tracker 

___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Terry J. Reedy]

Terry J. Reedy added the comment:

I like the current division, but agree that
  The TestCase class provides a number of methods to check for and
  report failures, such as:

is slightly misleading. I would change it to
  The TestCase class provides a number of methods to check for and
  report failures. The most commonly used are:
  ...table
  More are listed in the Regex, Comparisons, and Type-specific tables.

where each of Regex, Comparisons, and Type-specific link to their respective 
tables. (Repaint the link names if you wish ;-).

--
nosy: +terry.reedy

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19006
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Roy Smith]

Roy Smith added the comment:

The new text suggested by terry.reedy works for me.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19006
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Ezio Melotti]

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 rep...@bugs.python.org
http://bugs.python.org/issue19006
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Roy Smith]

New submission from Roy Smith:

http://docs.python.org/2/library/unittest.html#assert-methods

The docs say, The TestCase class provides a number of methods to check for and 
report failures, such as, and then when you scroll a couple of screens down, 
there's another list, There are also other methods used to perform more 
specific checks, such as.  These should be merged into a single list.  There's 
nothing fundamentally different about the two lists and breaking them into two 
parts just makes it harder to find what you want.

--
assignee: docs@python
components: Documentation
messages: 197492
nosy: docs@python, roysmith
priority: normal
severity: normal
status: open
title: UnitTest docs should have a single list of assertions
versions: Python 2.7

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19006
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Roy Smith]

Roy Smith added the comment:

Adding a note that there are more methods in the tables below would be useful.  
Otherwise, you assume you've seen them all when you've read the first table.

I agree that the assertions about exceptions and warnings belong in a different 
group, but I don't see any fundamental reason to put assertGreater in a 
different table from assertEqual.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19006
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com

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

[Ezio Melotti]

Ezio Melotti added the comment:

One reason is that if I list all those assert methods first and keep the 
assertRaises/Warns in a separate group, they will be pushed way down, and 
people might miss them.
I'll try to prepare a patch that adds links to the other tables and/or changes 
the wording to make it clear that there are more assert methods.

--

___
Python tracker rep...@bugs.python.org
http://bugs.python.org/issue19006
___
___
Python-bugs-list mailing list
Unsubscribe: 
https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com