Re-export __doc__ in __init__.py for pure Rust project

PyO3 · Oct 1, 2021 · 031d23e · 031d23e
1 parent 19a8b02
commit 031d23e
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 1 deletion.
diff --git a/src/module_writer.rs b/src/module_writer.rs
@@ -621,7 +621,11 @@ pub fn write_bindings_module(
             // Reexport the shared library as if it were the top level module
             writer.add_bytes(
                 &module.join("__init__.py"),
-                format!("from .{} import *\n", module_name).as_bytes(),
+                format!(
+                    "from .{module_name} import *\n\n__doc__ = {module_name}.__doc__\n",
+                    module_name = module_name
+                )
+                .as_bytes(),
             )?;
             let type_stub = rust_module.join(format!("{}.pyi", module_name));
             if type_stub.exists() {

diff --git a/test-crates/pyo3-pure/src/lib.rs b/test-crates/pyo3-pure/src/lib.rs
@@ -11,6 +11,7 @@ impl DummyClass {
     }
 }
 
+/// module level doc string
 #[pymodule]
 fn pyo3_pure(_py: Python, m: &PyModule) -> PyResult<()> {
     m.add_class::<DummyClass>()?;