From 248ced82878fe1dc22e099ac8ff69db36d3ea395 Mon Sep 17 00:00:00 2001
From: Dave Hrycyszyn <futurechimp@users.noreply.github.com>
Date: Thu, 30 May 2024 15:55:38 +0100
Subject: [PATCH] Added a few doc comments

---
 crates/bft-json-crdt/src/json_crdt.rs | 8 ++++++--
 1 file changed, 6 insertions(+), 2 deletions(-)

diff --git a/crates/bft-json-crdt/src/json_crdt.rs b/crates/bft-json-crdt/src/json_crdt.rs
index 78bb302..b8d5eac 100644
--- a/crates/bft-json-crdt/src/json_crdt.rs
+++ b/crates/bft-json-crdt/src/json_crdt.rs
@@ -427,14 +427,14 @@ where
     }
 }
 
-/// Trivial conversion from Value to Value as CrdtNodeFromValue
+/// Trivial conversion from [`JsonValue`] to [`JsonValue`] as [`CrdtNodeFromValue`]
 impl CrdtNodeFromValue for JsonValue {
     fn node_from(value: JsonValue, _id: AuthorId, _path: Vec<PathSegment>) -> Result<Self, String> {
         Ok(value)
     }
 }
 
-/// Conversions from primitives to CRDTs
+/// Conversions from bool to CRDT
 impl CrdtNodeFromValue for bool {
     fn node_from(value: JsonValue, _id: AuthorId, _path: Vec<PathSegment>) -> Result<Self, String> {
         if let JsonValue::Bool(x) = value {
@@ -445,6 +445,7 @@ impl CrdtNodeFromValue for bool {
     }
 }
 
+/// Conversions from f64 to CRDT
 impl CrdtNodeFromValue for f64 {
     fn node_from(value: JsonValue, _id: AuthorId, _path: Vec<PathSegment>) -> Result<Self, String> {
         if let JsonValue::Number(x) = value {
@@ -455,6 +456,7 @@ impl CrdtNodeFromValue for f64 {
     }
 }
 
+/// Conversions from i64 to CRDT
 impl CrdtNodeFromValue for i64 {
     fn node_from(value: JsonValue, _id: AuthorId, _path: Vec<PathSegment>) -> Result<Self, String> {
         if let JsonValue::Number(x) = value {
@@ -465,6 +467,7 @@ impl CrdtNodeFromValue for i64 {
     }
 }
 
+/// Conversions from String to CRDT
 impl CrdtNodeFromValue for String {
     fn node_from(value: JsonValue, _id: AuthorId, _path: Vec<PathSegment>) -> Result<Self, String> {
         if let JsonValue::String(x) = value {
@@ -475,6 +478,7 @@ impl CrdtNodeFromValue for String {
     }
 }
 
+/// Conversions from char to CRDT
 impl CrdtNodeFromValue for char {
     fn node_from(value: JsonValue, _id: AuthorId, _path: Vec<PathSegment>) -> Result<Self, String> {
         if let JsonValue::String(x) = value.clone() {