Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Perplexing documentation for API method #953

Open
A248 opened this issue Jan 17, 2022 · 0 comments
Open

Perplexing documentation for API method #953

A248 opened this issue Jan 17, 2022 · 0 comments
Labels
enhancement

Comments

@A248
Copy link
Contributor

A248 commented Jan 17, 2022

I was browsing through the BanManager API and came across this statement in the javadoc:

BanManager/common/src/main/java/me/confuser/banmanager/common/api/BmAPI.java

Line 472 in acb1ef1

* This method is not thread safe and should not be called on the main thread.

It is mostly obvious why such a statement is confusing. If an API method should not be called on the main thread, but is not thread safe, what thread should it be called on instead?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@confuser @A248