Python check_docstring Examples

Example #1

File: test_docstring.py Project: afiqmuzaffar/clumper

def test_clumper_docstrings(m):
    """
    Take the docstring of every method on the `Clumper` class.
    The test passes if the usage examples causes no errors.
    """
    check_docstring(m)

Example #2

File: test_docstring.py Project: afiqmuzaffar/clumper

def test_docstring(func):
    """Check docstring of each function."""
    check_docstring(obj=func)

Example #3

File: test_docs.py Project: timvink/tokenwiser

def test_member(obj):
    check_docstring(obj)

Example #4

def test_docstrings(func):
    check_docstring(func)

Example #5

def test_docstring(func):
    check_docstring(obj=func)

Example #6

def test_base_docstrings_bad(func, capsys):
    with pytest.raises(Exception):
        check_docstring(func)
        capsys.readouterr()
        assert func.__name__ in capsys.readouterr().out