wpilibsuite/wpilib-docs

Add documentation for multi-tasking/Notifier

Aperta

#1940 aperta il 25 ott 2022

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)JavaScript (297 fork)auto 404
AdditionHelp Wanted

Metriche repository

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

Descrizione

There is no documentation for how to use Notifier on the docs site. It would also be helpful to provide guidance on when threads/Notifier may be appropriate vs. .addPeriodic(). Peter Johnson's response on this thread on CD provides some good guidance.

There is a Scheduling Functions at Custom Frequencies page, but it only mentions that you do not need to use Notifier. It also doesn't point out that addPeriodic() is cooperative (on the main thread) where Notifier run on its own thread so it will not block the main robot loop.

Guida contributor

Direzione di ricerca
Prendi familiarità con la struttura della documentazione di WPILib. Individua la pagina esistente sulle funzioni di pianificazione. Comprendi la classe Notifier e il suo utilizzo. Crea una nuova pagina o aggiungi una sezione che spieghi quando usare Notifier e quando usare addPeriodic(). Includi esempi di codice per Java e C++. Fai riferimento al thread di Chief Delphi per ulteriore contesto. Invia una pull request.
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.
Mezza giornata
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