This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: "paths" argument missing in DocFileSuite documentation
Type: Stage:
Components: Documentation Versions: Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: georg.brandl, harobed
Priority: normal Keywords:

Created on 2009-03-29 21:54 by harobed, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Messages (2)
msg84434 - (view) Author: harobed (harobed) Date: 2009-03-29 21:54
This is DocFileSuite function source code
(http://svn.python.org/view/python/trunk/Lib/doctest.py) :

::

    def DocFileSuite(*paths, **kw):
        """A unittest suite for one or more doctest files.

        The path to each doctest file is given as a string; the
        interpretation of that string depends on the keyword argument
        "module_relative".

        A number of options may be provided as keyword arguments:

This is DocFileSuite documentation
(http://svn.python.org/view/python/trunk/Doc/library/doctest.rst) :

::

    .. function:: DocFileSuite([module_relative][, package][, setUp][,
tearDown][, globs][, optionflags][, parser][, encoding])

       Convert doctest tests from one or more text files to a
       :class:`unittest.TestSuite`.

       The returned :class:`unittest.TestSuite` is to be run by the
unittest framework
       and runs the interactive examples in each file.  If an example in
any file
       fails, then the synthesized unit test fails, and a
:exc:`failureException`
       exception is raised showing the name of the file containing the
test and a
       (sometimes approximate) line number.

       Pass one or more paths (as strings) to text files to be examined.


I think "paths" argument missing in this documentation.

Regards,
Stephane
msg84908 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-03-31 21:15
Fixed in r70896.
History
Date User Action Args
2022-04-11 14:56:47adminsetgithub: 49848
2009-03-31 21:15:44georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg84908
2009-03-29 21:54:28harobedcreate