-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Milestone
Description
The documentation is technically complete in the “every public item has a docstring” sense, but there are few examples of usage. The doc-tests tend to be heavy on "test" and light on "doc".
Docs/examples for specific items:
-
Cellexample (There is a more elaborate example inWakeFlag; make it simpler than that.) -
Cell::update_mut()example -
CellWithLocalbasic usage example - Using specific
LoadStoreimplementations withCell -
Constantbasic usage example (barely done in 7c249ab, but could use more realism) -
Flagbasic usage example -
Gateexample of dynamic dependencies together withCell, or at least some kind of switching sources -
Logbasic usage example -
Notifierbasic usage example (done in 67c2a9e) -
Notifier::close()usage/doctest -
Notifier::count()example demonstrating its exactness -
StoreLockbasic usage example (not focusing on implementingStore) -
FromListenerimplementation e.g. for an enum (done in d59ce22) -
Listenerimplementation examples- Simple correct implementations
- Tempting incorrect implementations
- A
Listenerthat writes to a channel — emphasize not blocking
-
LoadStoreimplementation -
Sourceimplementation -
Storeimplementation (done in e60de7d)
Examples not specific to an item:
- Usage in an event-loop-shaped application: read input, perform updates, display output.
- Usage in a reactive style application: as-needed updates in a complex graph.
- Example of using
Notifierwith non-type-erased listeners. - Example of waking threads using
Condvarorunpark().
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation