wpilibsuite/wpilib-docs

Clean up Command factory/constructor documentation

Ouverte

#2 293 ouverte le 17 juil. 2023

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (297 forks)auto 404
Good First Issue

Métriques du dépôt

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

Description

https://docs.wpilib.org/en/2023_a/docs/software/commandbased/commands.html

Currently there is an inconsistent/incomplete mix of using the constructor and using the factory method inside the code blocks, while the documentation refers to the factory methods.

The code blocks/RLIs also use the factory methods of Subsystem in the context of a subsystem (eg using this.runOnce) which can be confusing without the surrounding context.

Guide contributeur

Direction de recherche
Examinez la page de documentation liée, identifiez les blocs de code qui utilisent de manière incohérente le constructeur par rapport aux méthodes d'usine et comparez les avec le texte environnant qui fait référence aux méthodes d'usine. Mettez à jour les blocs de code pour correspondre à l'utilisation de la méthode d'usine décrite dans la documentation. Vérifiez également l'utilisation de `this.runOnce` dans le contexte du sous système et assurez la clarté.
Stack technique
javacpp
Domaine
documentation
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70