[docs] (minor issue) Missing string `_widget` in example code of unittest

John Gamboa vaulttech at gmail.com
Fri Jun 9 05:26:35 EDT 2017


*TL;DR*: instead of `test_default_size` and `test_resize`, the strings
should be `test_default_widget_size` and `test_default_resize` in the
snippet explaining how to create a test suite (defining the function
`suite()`) in the documentation of Python 3.


*Longer version:*

I was reading the unittest documentation (in
https://docs.python.org/3/library/unittest.html). It has this example code:

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def test_default_widget_size(self):
        self.assertEqual(self.widget.size(), (50,50),
                         'incorrect default size')

    def test_widget_resize(self):
        self.widget.resize(100,150)
        self.assertEqual(self.widget.size(), (100,150),
                         'wrong size after resize')

Here, the names of the functions have `_widget`. In the Python 2.7
documentation (in https://docs.python.org/2/library/unittest.html), they
didn't have:

class WidgetTestCase(unittest.TestCase):
    def setUp(self):
        self.widget = Widget('The widget')

    def tearDown(self):
        self.widget.dispose()
        self.widget = None

    def test_default_size(self):
        self.assertEqual(self.widget.size(), (50,50),
                         'incorrect default size')

    def test_resize(self):
        self.widget.resize(100,150)
        self.assertEqual(self.widget.size(), (100,150),
                         'wrong size after resize')


Now... in the Python 2.7 documentation, afterwards there was another
example code that mentioned this one:

widgetTestSuite =
unittest.TestSuite()widgetTestSuite.addTest(WidgetTestCase('test_default_size'))widgetTestSuite.addTest(WidgetTestCase('test_resize'))

However, in the Python 3.6 documentation, the names of the functions
(`test_default_size`) are still the same:

def suite():
    suite = unittest.TestSuite()
    suite.addTest(WidgetTestCase('test_default_size'))
    suite.addTest(WidgetTestCase('test_resize'))
    return suite

They should have become `test_default_widget_size` and `test_widget_resize`.

(I tried creating an account in the issue tracker, but there seemed to be
some problem with my registration)

-- 
John Gamboa
rabanetescebolas.blogspot.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.python.org/pipermail/docs/attachments/20170609/243eda1f/attachment.html>


More information about the docs mailing list