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

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

* add newsfragment

Author: Icxolu

newsfragments/4067.fixed.md

@@ -0,0 +1 @@
+fixes `missing_docs` lint to trigger on documented `#[pymodule]` functions

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
         }

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");
 }

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() {}