wpilibsuite/wpilib-docs

Clean up Command factory/constructor documentation

Aperta

#2293 aperta il 17 lug 2023

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (297 fork)auto 404
Good First Issue

Metriche repository

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

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina la pagina della documentazione collegata, identifica i blocchi di codice che utilizzano in modo incoerente il costruttore rispetto ai metodi factory e confrontali con il testo circostante che si riferisce ai metodi factory. Aggiorna i blocchi di codice per corrispondere all'uso del metodo factory descritto nella documentazione. Inoltre, verifica l'uso di `this.runOnce` nel contesto del sottosistema e assicurati che sia chiaro.
Tech stack
javacpp
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70