[runtime_config] Inline explanations on Fork_config.t fields.

MinaProtocol · Nov 28, 2023 · a681c0f · a681c0f
1 parent 6aa7a7c
commit a681c0f
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/src/lib/runtime_config/runtime_config.ml b/src/lib/runtime_config/runtime_config.ml
@@ -1,12 +1,13 @@
 open Core_kernel
 
 module Fork_config = struct
-  (* previous_global_slot here is a global slot since genesis. previous
-     length is a number of blocks produced since genesis, which might be
-     smaller than previous_global_slot or equal if a block was produced
-     in every slot possible, which may or may not be the case. *)
+  (* Note that previous_length might be smaller than the gernesis_slot
+     or equal if a block was produced in every slot possible. *)
   type t =
-    { previous_state_hash : string; previous_length : int; genesis_slot : int }
+    { previous_state_hash : string 
+    ; previous_length : int (* number of blocks produced since genesis *)
+    ; genesis_slot : int (* global slot since genesis *)
+    }
   [@@deriving yojson, bin_io_unversioned]
 
   let gen =