Skip to content

Commit

Permalink
Merge pull request #263 from neutrinoceros/doc/thread_safety_registry
Browse files Browse the repository at this point in the history
DOC: document thread-safety of `BoundaryRegistry`
  • Loading branch information
neutrinoceros authored Sep 3, 2024
2 parents 22d98ee + c51128c commit 04d4029
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -400,3 +400,7 @@ so this strategy can be overridden using the `lock` parameter:
- using `lock=None` will not use any lock, which in restricted conditions
leads to better walltime performances
- alternatively, an externally managed `threading.Lock` instance may be supplied

`Dataset.boundary_recipes.register` is also thread-safe: registering a shared
function multiple times is supported, but an error is raised in case one
attempts registering a different function under an existing key.

0 comments on commit 04d4029

Please sign in to comment.