vaadin/framework

Shortcut documentation is bit outdated and could be clearer

Aperta

#10.672 aperta il 2 mar 2018

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (0 assegnatari)Java (715 fork)auto 404
Help wantedStaledocumentation

Metriche repository

Star
 (1806 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Aggiorna la pagina advanced shortcuts.html per chiarire che ShortcutActions può essere aggiunto solo ai componenti Panel e Window, come indicato nell'issue. Rivedi la documentazione corrente e apporta le modifiche necessarie.
Tech stack
java
Dominio
frontend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitJava
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85