Cleanup/error-correction for unittest's docs

[collinwinter]

BPO	1534922
Nosy	@birkenfeld
Files	libunittest.tex.diff: Against r51122

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = <Date 2006-08-05.06:11:14.000>
created_at = <Date 2006-08-05.04:23:29.000>
labels = ['docs']
title = "Cleanup/error-correction for unittest's docs"
updated_at = <Date 2006-08-05.06:11:14.000>
user = 'https://bugs.python.org/collinwinter'

bugs.python.org fields:

activity = <Date 2006-08-05.06:11:14.000>
actor = 'georg.brandl'
assignee = 'none'
closed = True
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2006-08-05.04:23:29.000>
creator = 'collinwinter'
dependencies = []
files = ['7451']
hgrepos = []
issue_num = 1534922
keywords = ['patch']
message_count = 2.0
messages = ['50833', '50834']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'collinwinter']
pr_nums = []
priority = 'normal'
resolution = 'accepted'
stage = None
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue1534922'
versions = ['Python 2.5']

[collinwinter]

The following patch, in addition to widespread typo and
grammar corrections and style improvements, fixes the
following errors/irritations:

• Removes a link to the PyUnit website (pyunit.sf.net)
  and replaces use of the PyUnit name with unittest. The
  module has not been known by this name for years.

• TextTestRunner is documented varyingly as printing to
  stdout and stderr; the latter is correct. This is now
  fixed.

• Several usages of the deprecated makeSuite() function
  have been replaced with TestLoader()-based examples.

• One needlessly-complex TestSuite construction example
  has been simplified to something understandable.

• It is stated that classes that implement TestCase's
  interface can be used with unittest, even if they do
  not subclass TestCase. This is false, contradicting
  several other lines of documentation. Moreover, it does
  not reflect reality: unittest relies heavily on
  inheritance from TestCase to determine what is and what
  is not a test case.

• It has now been made explicit which methods TestSuite
  shares with TestCase. Previously, this had been left as
  an exercise for the reader.

• TestLoader.loadTestsFromName() was not documented as
  being able to handle a name that resolves to a
  TestSuite. It can, and this capability is now documented.

• The documentation implied that
  TestLoader.sortTestMethodsUsing affects only
  TestLoader.getTestCaseNames(). This is inaccurate; it
  is now explicit that it also affects all
  TestLoader.loadTestsFrom*() methods.

• Make it explicit that TestLoader.suiteClass and
  TestLoader.testMethodPrefix affect getTestCaseNames()
  and all loadTestsFrom*() methods.

[birkenfeld]

Logged In: YES
user_id=849994

Thanks for the patch, I committed it almost unchanged as
rev. 51123.