Shortcut documentation is bit outdated and could be clearer
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 1.8k
- Forks
- 717
- Avg merge
- 2d 6h
- Merged PRs (30d)
- 3
Description
Website feedback:advanced-shortcuts.html page is unclear about role of Panel and Window. It says that these either "accept" or "can attach" shortcuts actions. But shortcut actions are added to some component. Documentation could clearly say that shortcut actions should be added to Panel or Window. "Currently, the only classes that accept ShortcutActions are Window and Panel." "Notice that the keyboard actions can currently be attached only to Panels and Windows.
The feedback is not 100% correct, but the documentation could indeed get some clarifications.
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
Start with the advanced-shortcuts.html page mentioned in the issue and review how it describes Panel, Window, and ShortcutActions. Clarify that shortcut actions are currently added to or attached only to Panel and Window, then verify that the revised wording is accurate and unambiguous.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 88/100