wpilibsuite/wpilib-docs

Add documentation for multi-tasking/Notifier

Ouverte

#1 940 ouverte le 25 oct. 2022

Voir sur GitHub
 (0 commentaire) (0 réaction) (0 personne assignée)JavaScript (297 forks)auto 404
AdditionHelp Wanted

Métriques du dépôt

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

Description

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.

Guide contributeur

Direction de recherche
Familiarisez vous avec la structure de la documentation WPILib. Localisez la page existante sur les fonctions de planification. Comprenez la classe Notifier et son utilisation. Créez une nouvelle page ou ajoutez une section expliquant quand utiliser Notifier et quand utiliser addPeriodic(). Incluez des exemples de code pour Java et C++. Référez vous au fil Chief Delphi pour plus de contexte. Soumettez une pull request.
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.
Une demi journée
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