Skip to content

Commit

Permalink
Merge pull request #3690 from PyO3/check-signal-docs
Browse files Browse the repository at this point in the history
Copy note on using check_signals on non-main thread/interpreter from Python docs.
  • Loading branch information
davidhewitt committed Dec 22, 2023
2 parents a115877 + e58b251 commit 65f25d4
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions src/marker.rs
Original file line number Diff line number Diff line change
Expand Up @@ -906,6 +906,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<()> {
Expand Down

0 comments on commit 65f25d4

Please sign in to comment.