Copy note on using check_signals on non-main thread/interpreter from …

…Python docs.
PyO3 · Dec 29, 2023 · ecb0e9c · ecb0e9c
1 parent b842711
commit ecb0e9c
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/marker.rs b/src/marker.rs
@@ -907,6 +907,9 @@ impl<'py> Python<'py> {
     /// As Python's [`signal`][2] API allows users to define custom signal handlers, calling this
     /// function allows arbitrary Python code inside signal handlers to run.
     ///
+    /// If the function is called from a non-main thread, or under a non-main Python interpreter,
+    /// it does nothing yet still returns `Ok(())`.
+    ///
     /// [1]: https://docs.python.org/3/c-api/exceptions.html?highlight=pyerr_checksignals#c.PyErr_CheckSignals
     /// [2]: https://docs.python.org/3/library/signal.html
     pub fn check_signals(self) -> PyResult<()> {