Rephrase Logger documentation to be more explicit about thread-safety#110614
Merged
Repiteo merged 1 commit intogodotengine:masterfrom Sep 22, 2025
Merged
Rephrase Logger documentation to be more explicit about thread-safety#110614Repiteo merged 1 commit intogodotengine:masterfrom
Logger documentation to be more explicit about thread-safety#110614Repiteo merged 1 commit intogodotengine:masterfrom
Conversation
mihe
added
enhancement
documentation
cherrypick:4.5
Ivorforce
approved these changes
Sep 17, 2025
Member
Ivorforce
left a comment
Ivorforce
left a comment
There was a problem hiding this comment.
Makes sense to me. Either you do need thread safety mechanisms, or you don't. There's no in between.
Contributor
|
Thanks! |
akien-mga
removed
the
cherrypick:4.5
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The current phrasing (as written by me) of the thread-safety warning for
Logger._log_messageandLogger._log_erroris perhaps a bit too timid and arguably makes thread-safety sound optional, which it very much is not. Threads spun up by the engine internally can emit errors, which will invoke these callbacks from said threads, meaning any and all implementations ofLoggerare subject to race conditions unless accommodated for.I was/am a little bit tempted to throw in a scary "or you can crash the entire process" just to really drive home the point, but maybe that's excessive?