From d0da6de9ee1e969c93cae68c60515495cad98c84 Mon Sep 17 00:00:00 2001 From: denehoffman Date: Wed, 5 Jun 2024 01:58:25 -0400 Subject: [PATCH] fix: fixed failing docs --- crates/rustitude-core/src/amplitude.rs | 19 +++++++++++-------- 1 file changed, 11 insertions(+), 8 deletions(-) diff --git a/crates/rustitude-core/src/amplitude.rs b/crates/rustitude-core/src/amplitude.rs index 7eacb08..fee12d9 100644 --- a/crates/rustitude-core/src/amplitude.rs +++ b/crates/rustitude-core/src/amplitude.rs @@ -263,15 +263,18 @@ pub trait Node: Sync + Send { /// imaginary part of a single [`AmpOp`]. Sums of [`AmpOp`]s are handeled by the [`CohSum`] struct. /// /// These structs follow some rules for addition and multiplication: -/// ``` -/// AmpOp + AmpOp = CohSum -/// AmpOp + CohSum = CohSum // (appending) -/// CohSum + CohSum = CohSum // (concatenating) /// -/// AmpOp * AmpOp = AmpOp -/// AmpOp * CohSum = CohSum // AmpOp is distributed over terms of CohSum -/// CohSum * CohSum = UNDEFINED -/// ``` +/// > `AmpOp + AmpOp = CohSum` +/// > +/// > `AmpOp + CohSum = CohSum` (appending) +/// > +/// > `CohSum + CohSum = CohSum` (concatenating) +/// +/// > `AmpOp * AmpOp = AmpOp` +/// > +/// > `AmpOp * CohSum = CohSum` (`AmpOp` is distributed over terms of `CohSum`) +/// > +/// > `CohSum * CohSum = UNDEFINED` /// /// This format should be able to handle any generalized intensity equation based on amplitude /// nodes. For instance, if an incoherent sum is needed, two separate [`CohSum`]s can be created