examples: export __doc__ in example projects

PyO3 · Oct 1, 2021 · 5d5ad25 · 5d5ad25
1 parent e4b9840
commit 5d5ad25
Show file tree

Hide file tree

Showing 6 changed files with 33 additions and 2 deletions.
diff --git a/examples/maturin-starter/maturin_starter/__init__.py b/examples/maturin-starter/maturin_starter/__init__.py
@@ -1,6 +1,12 @@
 # import the contents of the Rust library into the Python extension
 from .maturin_starter import *
 
+# optional: include the documentation from the Rust module
+from . import maturin_starter
+
+__doc__ = maturin_starter.__doc__
+__all__ = maturin_starter.__all__ + ["PythonClass"]
+
 
 class PythonClass:
     def __init__(self, value: int) -> None:

diff --git a/examples/maturin-starter/src/lib.rs b/examples/maturin-starter/src/lib.rs
@@ -19,6 +19,7 @@ impl ExampleClass {
     }
 }
 
+/// An example module implemented in Rust using PyO3.
 #[pymodule]
 fn maturin_starter(py: Python, m: &PyModule) -> PyResult<()> {
     m.add_class::<ExampleClass>()?;

diff --git a/examples/maturin-starter/tests/test_maturin_starter.py b/examples/maturin-starter/tests/test_maturin_starter.py
@@ -1,4 +1,4 @@
-from maturin_starter import PythonClass, ExampleClass
+from maturin_starter import ExampleClass, PythonClass
 
 
 def test_python_class() -> None:
@@ -9,3 +9,11 @@ def test_python_class() -> None:
 def test_example_class() -> None:
     example = ExampleClass(value=11)
     assert example.value == 11
+
+
+def test_doc() -> None:
+    import maturin_starter
+
+    assert (
+        maturin_starter.__doc__ == "An example module implemented in Rust using PyO3."
+    )
diff --git a/examples/setuptools-rust-starter/setuptools_rust_starter/__init__.py b/examples/setuptools-rust-starter/setuptools_rust_starter/__init__.py
@@ -1,6 +1,12 @@
 # import the contents of the Rust library into the Python extension
 from ._setuptools_rust_starter import *
 
+# optional: include the documentation from the Rust module
+from . import setuptools_rust_starter
+
+__doc__ = setuptools_rust_starter.__doc__
+__all__ = setuptools_rust_starter.__all__ + ["PythonClass"]
+
 
 class PythonClass:
     def __init__(self, value: int) -> None:

diff --git a/examples/setuptools-rust-starter/src/lib.rs b/examples/setuptools-rust-starter/src/lib.rs
@@ -19,6 +19,7 @@ impl ExampleClass {
     }
 }
 
+/// An example module implemented in Rust using PyO3.
 #[pymodule]
 fn _setuptools_rust_starter(py: Python, m: &PyModule) -> PyResult<()> {
     m.add_class::<ExampleClass>()?;

diff --git a/examples/setuptools-rust-starter/tests/test_setuptools_rust_starter.py b/examples/setuptools-rust-starter/tests/test_setuptools_rust_starter.py
@@ -1,4 +1,4 @@
-from setuptools_rust_starter import PythonClass, ExampleClass
+from setuptools_rust_starter import ExampleClass, PythonClass
 
 
 def test_python_class() -> None:
@@ -9,3 +9,12 @@ def test_python_class() -> None:
 def test_example_class() -> None:
     example = ExampleClass(value=11)
     assert example.value == 11
+
+
+def test_doc() -> None:
+    import setuptools_rust_starter
+
+    assert (
+        setuptools_rust_starter.__doc__
+        == "An example module implemented in Rust using PyO3."
+    )