From fd18955da8f4b768b9b626a6e0ccc48bde7b85ab Mon Sep 17 00:00:00 2001
From: Icxolu <10486322+Icxolu@users.noreply.github.com>
Date: Fri, 12 Apr 2024 08:34:08 +0200
Subject: [PATCH] add `#[doc(hidden)]` to the Rust module created by
 `#[pymodule]` (#4067)

* add `#[doc(hidden)]` to the Rust module created by `#[pymodule]`

* add newsfragment
---
 newsfragments/4067.fixed.md       |  1 +
 pyo3-macros-backend/src/module.rs |  1 +
 tests/test_compile_error.rs       |  1 +
 tests/ui/pymodule_missing_docs.rs | 12 ++++++++++++
 4 files changed, 15 insertions(+)
 create mode 100644 newsfragments/4067.fixed.md
 create mode 100644 tests/ui/pymodule_missing_docs.rs

diff --git a/newsfragments/4067.fixed.md b/newsfragments/4067.fixed.md
new file mode 100644
index 00000000..869b6add
--- /dev/null
+++ b/newsfragments/4067.fixed.md
@@ -0,0 +1 @@
+fixes `missing_docs` lint to trigger on documented `#[pymodule]` functions
\ No newline at end of file
diff --git a/pyo3-macros-backend/src/module.rs b/pyo3-macros-backend/src/module.rs
index 080a279a..8ff720cc 100644
--- a/pyo3-macros-backend/src/module.rs
+++ b/pyo3-macros-backend/src/module.rs
@@ -324,6 +324,7 @@ pub fn pymodule_function_impl(mut function: syn::ItemFn) -> Result<TokenStream>
 
     Ok(quote! {
         #function
+        #[doc(hidden)]
         #vis mod #ident {
             #initialization
         }
diff --git a/tests/test_compile_error.rs b/tests/test_compile_error.rs
index 38b5c472..44049620 100644
--- a/tests/test_compile_error.rs
+++ b/tests/test_compile_error.rs
@@ -53,4 +53,5 @@ fn test_compile_errors() {
     #[cfg(feature = "experimental-async")]
     #[cfg(any(not(Py_LIMITED_API), Py_3_10))] // to avoid PyFunctionArgument for &str
     t.compile_fail("tests/ui/invalid_cancel_handle.rs");
+    t.pass("tests/ui/pymodule_missing_docs.rs");
 }
diff --git a/tests/ui/pymodule_missing_docs.rs b/tests/ui/pymodule_missing_docs.rs
new file mode 100644
index 00000000..1b196fa6
--- /dev/null
+++ b/tests/ui/pymodule_missing_docs.rs
@@ -0,0 +1,12 @@
+#![deny(missing_docs)]
+//! Some crate docs
+
+use pyo3::prelude::*;
+
+/// Some module documentation
+#[pymodule]
+pub fn python_module(_m: &Bound<'_, PyModule>) -> PyResult<()> {
+    Ok(())
+}
+
+fn main() {}