Document command rate limiting
Open
Nobody has claimed this yet.
type: feature
- Dominant language
- Java
- Stars
- 2.3k
- Forks
- 959
- Avg merge
- 5d 10h
- Merged PRs (30d)
- 2
Description
Add javadoc to the CommandExecuteEvent and PostCommandInvocationEvent documenting the command rate limiting behaviour.
Why is this needed?
Unawareness, see for example #1635
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Locate the CommandExecuteEvent and PostCommandInvocationEvent entry points and read their existing Javadocs and related command-invocation documentation. Document the command rate-limiting behaviour in both event classes, with completion shown by clear Javadocs that address the unawareness described in #1635.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100