docs: note with_gil auto-creates thread state

PyO3 · Aug 23, 2022 · f7ebda8 · f7ebda8
1 parent fb05e1d
commit f7ebda8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/marker.rs b/src/marker.rs
@@ -288,6 +288,10 @@ impl Python<'_> {
     #[cfg_attr(PyPy, doc = "`prepare_freethreaded_python`")]
     /// for details.
     ///
+    /// If the current thread does not yet have a Python "thread state" associated with it,
+    /// a new one will be automatically created before `F` is executed and destroyed after `F`
+    /// completes.
+    ///
     /// # Panics
     ///
     /// - If the [`auto-initialize`] feature is not enabled and the Python interpreter is not