vaadin/framework

Shortcut documentation is bit outdated and could be clearer

Ouverte

#10 672 ouverte le 2 mars 2018

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (0 personne assignée)Java (715 forks)auto 404
Help wantedStaledocumentation

Métriques du dépôt

Stars
 (1 806 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

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.

Guide contributeur

Direction de recherche
Mettez à jour la page advanced shortcuts.html pour clarifier que ShortcutActions ne peut être ajouté qu'aux composants Panel et Window, comme indiqué dans le problème. Examinez la documentation actuelle et effectuez les modifications nécessaires.
Stack technique
java
Domaine
frontend
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitJava
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85