From 8dc8a34a55762a9b204843f3453f497c1c2c65e9 Mon Sep 17 00:00:00 2001 From: Ivan Dugalic Date: Tue, 17 Oct 2023 21:52:26 +0200 Subject: [PATCH] Rust doc improved --- src/aggregate.rs | 4 ++-- src/materialized_view.rs | 2 +- src/saga.rs | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/aggregate.rs b/src/aggregate.rs index 0d53bb7..35516ee 100644 --- a/src/aggregate.rs +++ b/src/aggregate.rs @@ -26,7 +26,7 @@ pub trait EventRepository { /// Event Sourced Aggregate. /// -/// It is using a [Decider] / [EventComputation] to compute new events based on the current events and the command. +/// It is using a `Decider` / [EventComputation] to compute new events based on the current events and the command. /// It is using a [EventRepository] to fetch the current events and to save the new events. /// /// Generic parameters: @@ -95,7 +95,7 @@ pub trait StateRepository { /// State Stored Aggregate. /// -/// It is using a [Decider] / [StateComputation] to compute new state based on the current state and the command. +/// It is using a `Decider` / [StateComputation] to compute new state based on the current state and the command. /// It is using a [StateRepository] to fetch the current state and to save the new state. /// /// Generic parameters: diff --git a/src/materialized_view.rs b/src/materialized_view.rs index 0e21c73..f3c550d 100644 --- a/src/materialized_view.rs +++ b/src/materialized_view.rs @@ -21,7 +21,7 @@ pub trait ViewStateRepository { /// Materialized View. /// -/// It is using a [View] / [ViewStateComputation] to compute new state based on the current state and the event. +/// It is using a `View` / [ViewStateComputation] to compute new state based on the current state and the event. /// It is using a [ViewStateRepository] to fetch the current state and to save the new state. /// /// Generic parameters: diff --git a/src/saga.rs b/src/saga.rs index 12548a3..dfd9155 100644 --- a/src/saga.rs +++ b/src/saga.rs @@ -1,6 +1,6 @@ use crate::ReactFunction; -/// [Saga] is a datatype that represents the central point of control, deciding what to execute next ([A]), based on the action result ([AR]). +/// [Saga] is a datatype that represents the central point of control, deciding what to execute next (`A`), based on the action result (`AR`). /// It has two generic parameters `AR`/Action Result, `A`/Action , representing the type of the values that Saga may contain or use. /// `'a` is used as a lifetime parameter, indicating that all references contained within the struct (e.g., references within the function closures) must have a lifetime that is at least as long as 'a. ///