[issue20039] Missing documentation for argparse.ArgumentTypeError
Arnaut Billings added the comment: It seems what you're saying is that the ArgumentTypeError class should not be public, but being able to raise is should be public. If that's the case, I think it would be more clear to have an argparse.raiseArgumentTypeError method and document when it should be used. If such classes are meant to be private, why not prepend their names with an underscore and remove them from the __all__ list? (I thought a leading underscore meant that a module level variable was private to that module.) -- ___ Python tracker <http://bugs.python.org/issue20039> ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue20039] Missing documentation for argparse.ArgumentTypeError
New submission from Arnaut Billings: There is no documentation for argparse.ArgumentTypeError: http://docs.python.org/3/library/unittest.html Though it does appear in an example and its usage is simple enough to decipher what it means, it would none the less look more professional if there was formal documentation for it. Not only on what it is, but when it should actually be used, etc... -- assignee: docs@python components: Documentation messages: 206723 nosy: arnaut-billings, docs@python priority: normal severity: normal status: open title: Missing documentation for argparse.ArgumentTypeError versions: Python 3.3 ___ Python tracker <http://bugs.python.org/issue20039> ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue20031] unittest.TextTestRunner missing run() documentation.
New submission from Arnaut Billings: Here: http://docs.python.org/3/library/unittest.html 1) unittest.TextTestRunner is missing documentation for its public run method. 2) There are references to the TestRunner class sprinkled through out the above page, yet no link or documentation as to what that class actually is and does. -- assignee: docs@python components: Documentation messages: 206671 nosy: arnaut-billings, docs@python priority: normal severity: normal status: open title: unittest.TextTestRunner missing run() documentation. versions: Python 3.3 ___ Python tracker <http://bugs.python.org/issue20031> ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
[issue20030] unittest.TestLoader.discover return value incorrectly documented.
New submission from Arnaut Billings: Here: http://docs.python.org/3/library/unittest.html#unittest.TestLoader.discover it states that "Find and return all test modules ..." This implies that in order to get a test suite, one has to iterate over the return value of unittest.TestLoader.discover and call loadTestsFromModule for each module. But, the type of the result of unittest.TestLoader.discover returns: -- assignee: docs@python components: Documentation messages: 206670 nosy: arnaut-billings, docs@python priority: normal severity: normal status: open title: unittest.TestLoader.discover return value incorrectly documented. versions: Python 3.3 ___ Python tracker <http://bugs.python.org/issue20030> ___ ___ Python-bugs-list mailing list Unsubscribe: https://mail.python.org/mailman/options/python-bugs-list/archive%40mail-archive.com
