docs: audit schedulers and terminables pages#18
Merged
Conversation
Verified all method names, signatures, parameter orders, and return types against source code. Key changes: schedulers.md: - Add Scheduler access table (sync, async, get, bukkit, builder) - Add complete Scheduler methods table with all overloads - Document TaskBuilder API (builder chain, timing, terminal methods) - Document Promise chain methods (thenApply/Accept/Run/Compose Sync/Async) - Add Ticks utility section with conversion methods and constants - Fix Promise example to use thenAcceptSync instead of thenApplySync where the return value was unused - Replace inline tick arithmetic with builder TimeUnit API in examples - Restructure with informative headings and tables terminables.md: - Add interface hierarchy table covering Terminable, TerminableConsumer, CompositeTerminable, TerminableModule, Task, and Promise - Confirm BasePlugin implements TerminableConsumer - Add CompositeTerminable method table (create, createWeak, with, withAll, cleanup, bind, bindModule) - Remove emoji checkmarks from Benefits section - Consolidate "Benefits", "Without Terminables", and "With Terminables" into a single comparison section - Remove redundant inline comments from code examples
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.
Summary
schedulers.mdandterminables.mdagainst all source interfaces (Schedulers,Scheduler,Task,TaskBuilder,ContextualTaskBuilder,ContextualPromiseBuilder,Promise,Terminable,TerminableConsumer,CompositeTerminable,TerminableModule)Schedulers.builder()API, allSchedulermethods (supply, call, supplyLater, callLater, and TimeUnit overloads), Promise chain methods (thenApply/Accept/Run/Compose with Sync/Async/Delayed variants),Ticksutility, andCompositeTerminablemethod tablethenApplySyncwiththenAcceptSyncwhere return value was unused, replaced inline tick arithmetic withTaskBuilderTimeUnit APIBasePlugin implements TerminableConsumerTest plan