Hide docs for any (#3254)

launchbadge · Jun 6, 2024 · c57bcb9 · c57bcb9
1 parent 5da0f73
commit c57bcb9
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/sqlx-postgres/src/lib.rs b/sqlx-postgres/src/lib.rs
@@ -26,6 +26,12 @@ pub mod types;
 mod value;
 
 #[cfg(feature = "any")]
+// We are hiding the any module with its AnyConnectionBackend trait
+// so that IDEs don't show it in the autocompletion list
+// and end users don't accidentally use it. This can result in
+// nested transactions not behaving as expected.
+// For more information, see https://github.com/launchbadge/sqlx/pull/3254#issuecomment-2144043823
+#[doc(hidden)]
 pub mod any;
 
 #[cfg(feature = "migrate")]