Alexander Hess
3cfc0db136
- make `GF2`, `one`, and `zero`, defined in the `lalib.elements.gf2` module, available as top-level imports in the `lalib.elements` sub-package via `from lalib.elements import *` - provide some code snippets in the sub-package's docstring - test the star import
25 lines
589 B
Python
25 lines
589 B
Python
"""Integrate `xdoctest` into the test suite.
|
|
|
|
Ensure all code snippets in docstrings are valid and functioning code.
|
|
|
|
Important: All modules with docstrings containing code snippets
|
|
must be put on the parameter list below by hand!
|
|
"""
|
|
|
|
import pytest
|
|
import xdoctest
|
|
|
|
|
|
@pytest.mark.parametrize(
|
|
"module",
|
|
[
|
|
"lalib",
|
|
"lalib.elements",
|
|
"lalib.elements.gf2",
|
|
],
|
|
)
|
|
def test_docstrings(module):
|
|
"""Test code snippets within the package with `xdoctest`."""
|
|
result = xdoctest.doctest_module(module, "all")
|
|
|
|
assert result["n_failed"] == 0
|