Skip to content

Commit

Permalink
update docs for PyModule::gil_used
Browse files Browse the repository at this point in the history
  • Loading branch information
ngoldbaum committed Oct 28, 2024
1 parent 31b3fae commit 356b2ac
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/types/module.rs
Original file line number Diff line number Diff line change
Expand Up @@ -389,13 +389,13 @@ pub trait PyModuleMethods<'py>: crate::sealed::Sealed {

/// Declare whether or not this module supports running with the GIL disabled
///
/// If the module does not rely on the GIL for thread safety, you can pass True
/// to this function to indicate the module does not rely on the GIL for
/// thread-safety.
/// If the module does not rely on the GIL for thread safety, you can pass
/// `false` to this function to indicate the module does not rely on the GIL
/// for thread-safety.
///
/// This function sets the [`Py_MOD_GIL`
/// slot](https://docs.python.org/3/c-api/module.html#c.Py_mod_gil) on the
/// module object. The default is `Py_MOD_GIL_USED`, so passing `false` to
/// module object. The default is `Py_MOD_GIL_USED`, so passing `true` to
/// this function is a no-op unless you have already set `Py_MOD_GIL` to
/// `Py_MOD_GIL_NOT_USED` elsewhere.
///
Expand Down

0 comments on commit 356b2ac

Please sign in to comment.