diff --git a/docs/simple.rst b/docs/simple.rst index 1d7a606..9750b8d 100644 --- a/docs/simple.rst +++ b/docs/simple.rst @@ -8,8 +8,11 @@ It can include specific function docs here: .. autofunction:: math.log -And here's the docs for our second module: +And here's the docs for our second module. We'll include ``undoc-members`` this +time: .. automodule:: simple :members: + :undoc-members: +And that's all she wrote. diff --git a/src/simple.py b/src/simple.py index 50c700b..d84ae78 100644 --- a/src/simple.py +++ b/src/simple.py @@ -1,8 +1,7 @@ __all__ = ["SIMPLE_CONST", "bar"] -SIMPLE_CONST = 2 +SIMPLE_CONST = 2 #: The number 2 def bar(a, b): - """Returns whether :a: and :b: have passed the bar exam in their state.""" return a + b > SIMPLE_CONST