fix: fixed failing docs

denehoffman · Jun 5, 2024 · d0da6de · d0da6de
1 parent db70e53
commit d0da6de
Showing 1 changed file with 11 additions and 8 deletions.
diff --git 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