From 7fbf8d5a775778f74512ebdbb39c52752d2cc354 Mon Sep 17 00:00:00 2001 From: Stuart Harris Date: Wed, 29 Jan 2025 13:44:10 +0000 Subject: [PATCH] crux_core mod docs --- crux_core/src/lib.rs | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/crux_core/src/lib.rs b/crux_core/src/lib.rs index 67082b35..5fdb5243 100644 --- a/crux_core/src/lib.rs +++ b/crux_core/src/lib.rs @@ -22,7 +22,7 @@ //! * Shell - the native side of the app on each platform handling UI and executing side effects //! //! * App - the main module of the core containing the application logic, especially model changes -//! and side-effects triggered by events. App can be composed from modules, each resembling a smaller, simpler app. +//! and side-effects triggered by events. An App can delegate to child apps, mapping Events and Effects. //! //! * Event - main input for the core, typically triggered by user interaction in the UI //! @@ -34,7 +34,11 @@ //! interaction with the host platform. Updating the UI is considered an effect. //! //! * Capability - A user-friendly API used to request effects and provide events that should be dispatched -//! when the effect is completed. For example, a HTTP client is a capability. +//! when an effect is completed. For example, a HTTP client is a capability. +//! +//! * Command - A description of a side-effect to be executed by the shell. Commands can be combined +//! (synchronously with combinators, or asynchronously with Rust async) to run +//! sequentially or concurrently, or any combination thereof. //! //! Below is a minimal example of a Crux-based application Core: //!