docs: clarify thread safety javadoc and fix typos in BmAPI#1058
Merged
docs: clarify thread safety javadoc and fix typos in BmAPI#1058
Conversation
Reword the contradictory "not thread safe and should not be called on the main thread" statement to clearly separate the two constraints: blocking I/O (don't call on the main thread) and lack of internal synchronization (caller must synchronize concurrent access). Applied to getWarnings, getPlayerNames, getPlayerHistory, getPlayerNameAt, getBanRecords(PlayerData), getMuteRecords, and getBanRecords(IPAddress). Also fixes: - "mutened" -> "muted" typo in three mute method javadocs - "warningss" -> "warnings" typo in getWarnings - misleading "IP to ban" @param on isBanned, getCurrentBan, and getBanRecords query methods
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
1 participant
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.
Reword the contradictory "not thread safe and should not be called on the main thread" statement to clearly separate the two constraints: blocking I/O (don't call on the main thread) and lack of internal synchronization (caller must synchronize concurrent access).
Applied to getWarnings, getPlayerNames, getPlayerHistory, getPlayerNameAt, getBanRecords(PlayerData), getMuteRecords, and getBanRecords(IPAddress).
Also fixes:
fixes #953