Skip to content

docs: audit cooldowns and utilities pages#20

Merged
demengc merged 1 commit intomainfrom
worktree-agent-aa65ec09
Mar 24, 2026
Merged

docs: audit cooldowns and utilities pages#20
demengc merged 1 commit intomainfrom
worktree-agent-aa65ec09

Conversation

@demengc
Copy link
Copy Markdown
Owner

@demengc demengc commented Mar 24, 2026

Summary

  • Verified all method names, signatures, return types, and behavioral claims in cooldowns.md and utilities.md against the current source code
  • Fixed cooldown test/reset semantics documentation: test() returns true when cooldown is NOT active and resets the timer; testSilently() returns true when NOT active without resetting
  • Added missing API coverage: Cooldown.ofTicks(), remainingMillis(), getLastTested()/setLastTested(), copy(), getAll(), put(), standalone Cooldown usage, and all Common number-parsing/null-handling/utility methods
  • Restructured both pages: tables for method listings, removed redundant sections (Error Handling, Version-Specific Code, Player Selection that duplicated earlier content), parallel structure across all utility sections
  • Verified Services.provide(Class, T) 2-param overload is valid (uses BaseManager.getPlugin() internally)
  • Verified Sounds.playToPlayer custom prefix behavior against source; no playToWorld method exists

Test plan

  • Verify markdown renders correctly in GitBook
  • Spot-check code examples against IDE autocompletion to confirm they compile

Verify all method names, signatures, and behavioral claims against source
code. Fix test/reset semantics documentation, add missing API methods
(ofTicks, remainingMillis, getLastTested, setLastTested, copy, getAll,
put, standalone Cooldown usage). Add missing Common utilities (checkInt,
checkFloat, checkLong, checkDouble, formatDecimal, getOrDefault,
getOrError, hasPermission, checkClass, forEachInt). Restructure both
pages to use tables for method listings, remove redundant sections
(Error Handling, Version-Specific Code, Player Selection), and apply
parallel structure throughout.
@demengc demengc merged commit ac518cb into main Mar 24, 2026
2 of 3 checks passed
@demengc demengc deleted the worktree-agent-aa65ec09 branch March 24, 2026 02:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant