wpilibsuite/wpilib-docs

Add documentation for multi-tasking/Notifier

Open

#1,940 opened on Oct 25, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (297 forks)auto 404
AdditionHelp Wanted

Repository metrics

Stars
 (187 stars)
PR merge metrics
 (PR metrics pending)

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.

Contributor guide

Research direction
Familiarize yourself with the WPILib documentation structure. Locate the existing page on scheduling functions. Understand the Notifier class and its usage. Create a new page or add a section that explains when to use Notifier and when to use addPeriodic(). Include code examples for Java and C++. Refer to the Chief Delphi thread for additional context. Submit a pull request.
Tech stack
javacpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70