[Brigadier] Document command syntax exceptions
Nobody has claimed this yet.
- Dominant language
- MDX
- Stars
- 73
- Forks
- 280
- Avg merge
- 20h 52m
- Merged PRs (30d)
- 4
Description
[!NOTE]
This issue is part of a series of issues regarding the extension of the Paper documentation regarding Paper's Brigadier API.
Combining with #528, it would be very useful to have documentation on CommandSyntaxExceptions. This should cover the build-in exceptions as well as the SimpleCommandExceptionType implementation of the CommandExceptionType interface.
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
No file, test, or entry point is named. Locate the Paper documentation section for the Brigadier API, then review how built-in CommandSyntaxExceptions and SimpleCommandExceptionType are currently covered. Done means both exception categories and their usage are documented, including the relationship to CommandExceptionType.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100