Incendo / Incendo/cloud-minecraft
[Suggestion] Display Argument descriptions as hover for Minecraft Help syntaxes
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 110
- Forks
- 29
- PR merge metrics
- No merged PRs in 30d
Description
Right now the output of MinecraftHelp when displaying commands only has a single hover applied across the whole Command itself.
It would be great if arguments could have their descriptions added as hover to the help output, as it could help to explain to the user a few things.
This of course would be a huge rework tho... From what I could gather is the current setup using the syntax() of the CommandEntry<C> which is just a string.
So this change would most likely require to use the Command<C> value itself to generate the full command syntax here.
I hope this can be considered.
Contributor guide
No contributing guide indexed for this repository
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
Start by tracing MinecraftHelp's use of CommandEntry and its syntax() string. Compare that path with the Command value to determine how argument descriptions are represented. The work is done when each argument in the help output can display its own description as a hover, rather than applying one hover to the entire command.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100