summaryrefslogtreecommitdiff
path: root/numpydoc/tests/test_main.py
diff options
context:
space:
mode:
Diffstat (limited to 'numpydoc/tests/test_main.py')
-rw-r--r--numpydoc/tests/test_main.py48
1 files changed, 26 insertions, 22 deletions
diff --git a/numpydoc/tests/test_main.py b/numpydoc/tests/test_main.py
index 1ba2549..1f90b96 100644
--- a/numpydoc/tests/test_main.py
+++ b/numpydoc/tests/test_main.py
@@ -37,7 +37,7 @@ def _capture_stdout(func_name, *args, **kwargs):
sys.stdout, old_stdout = f, sys.stdout
try:
func_name(*args, **kwargs)
- return f.getvalue().strip('\n\r')
+ return f.getvalue().strip("\n\r")
finally:
sys.stdout = old_stdout
@@ -65,49 +65,53 @@ def _invalid_docstring():
def test_renders_package_docstring():
- out = _capture_stdout(numpydoc.__main__.render_object,
- 'numpydoc')
- assert out.startswith('This package provides the numpydoc Sphinx')
+ out = _capture_stdout(numpydoc.__main__.render_object, "numpydoc")
+ assert out.startswith("This package provides the numpydoc Sphinx")
def test_renders_module_docstring():
- out = _capture_stdout(numpydoc.__main__.render_object,
- 'numpydoc.__main__')
- assert out.startswith('Implementing `python -m numpydoc` functionality.')
+ out = _capture_stdout(numpydoc.__main__.render_object, "numpydoc.__main__")
+ assert out.startswith("Implementing `python -m numpydoc` functionality.")
def test_renders_function_docstring():
- out = _capture_stdout(numpydoc.__main__.render_object,
- 'numpydoc.tests.test_main._capture_stdout')
- assert out.startswith('Return stdout of calling')
+ out = _capture_stdout(
+ numpydoc.__main__.render_object, "numpydoc.tests.test_main._capture_stdout"
+ )
+ assert out.startswith("Return stdout of calling")
def test_render_object_returns_correct_exit_status():
exit_status = numpydoc.__main__.render_object(
- 'numpydoc.tests.test_main._capture_stdout')
+ "numpydoc.tests.test_main._capture_stdout"
+ )
assert exit_status == 0
with pytest.raises(ValueError):
- numpydoc.__main__.render_object(
- 'numpydoc.tests.test_main._invalid_docstring')
+ numpydoc.__main__.render_object("numpydoc.tests.test_main._invalid_docstring")
def test_validate_detects_errors():
- out = _capture_stdout(numpydoc.__main__.validate_object,
- 'numpydoc.tests.test_main._docstring_with_errors')
- assert 'SS02' in out
- assert 'Summary does not start with a capital letter' in out
+ out = _capture_stdout(
+ numpydoc.__main__.validate_object,
+ "numpydoc.tests.test_main._docstring_with_errors",
+ )
+ assert "SS02" in out
+ assert "Summary does not start with a capital letter" in out
exit_status = numpydoc.__main__.validate_object(
- 'numpydoc.tests.test_main._docstring_with_errors')
+ "numpydoc.tests.test_main._docstring_with_errors"
+ )
assert exit_status > 0
def test_validate_perfect_docstring():
- out = _capture_stdout(numpydoc.__main__.validate_object,
- 'numpydoc.tests.test_main._capture_stdout')
- assert out == ''
+ out = _capture_stdout(
+ numpydoc.__main__.validate_object, "numpydoc.tests.test_main._capture_stdout"
+ )
+ assert out == ""
exit_status = numpydoc.__main__.validate_object(
- 'numpydoc.tests.test_main._capture_stdout')
+ "numpydoc.tests.test_main._capture_stdout"
+ )
assert exit_status == 0