docs: add thread safety section to Android and iOS integration guides#814
Merged
Conversation
Because * Engineers integrating with Nimbus on mobile frequently ask about the threading model and whether APIs are safe to call from any thread * This information exists only as code annotations scattered across FeatureHolder.kt, Nimbus.kt, and the Rust core, with no prose docs This commit * Adds a "Thread Safety" section to both the Android and iOS integration guides covering the FML-generated FeatureHolder API (fully thread-safe) and the lower-level NimbusInterface (some methods require background threads) Fixes #813
jaredlockhart
requested review from
freshstrangemusic,
mikewilli,
relud and
yashikakhurana
as code owners
Because * The integration guides are for app developers who interact with the FML-generated feature API, not the lower-level SDK internals This commit * Removes the "Lower-level NimbusInterface APIs" subsections from both Android and iOS integration guides, keeping only the public FeatureHolder API thread safety documentation
ncalexan
reviewed
Apr 2, 2026
ncalexan
left a comment
ncalexan
left a comment
Member
There was a problem hiding this comment.
This might be a bit more detailed than is necessary, but it still works for me. Thanks! Just having something that will hit for "thread"/"threads"/"thread safety" will be helpful.
freshstrangemusic
approved these changes
Apr 2, 2026
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
3 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.
Because
threading model and whether APIs are safe to call from any thread
FeatureHolder.kt,Nimbus.kt, and the Rust core, with no prose docsThis commit
guides covering the FML-generated
FeatureHolderAPI (fully thread-safe)and the lower-level
NimbusInterface(some methods require backgroundthreads)
Fixes #813