From 9697bed830976c46f4643d673c75e893c090637c Mon Sep 17 00:00:00 2001
From: Yasunari Watanabe <yasunari.watanabe@ahrefs.com>
Date: Mon, 10 Jan 2022 09:16:48 +0800
Subject: [PATCH] add comments

---
 lib/context.ml | 1 +
 lib/state.ml   | 2 +-
 2 files changed, 2 insertions(+), 1 deletion(-)

diff --git a/lib/context.ml b/lib/context.ml
index 81913897..bfc345a1 100644
--- a/lib/context.ml
+++ b/lib/context.ml
@@ -95,6 +95,7 @@ let refresh_state ctx =
       match get_local_file path with
       | Error e -> fmt_error "error while getting local file: %s\nfailed to get state from file %s" e path
       | Ok file ->
+        (* todo: extract state related parts to state.ml *)
         let state = { ctx.state with state = State_j.state_of_string file } in
         Ok { ctx with state }
     end
diff --git a/lib/state.ml b/lib/state.ml
index 76557838..c0543403 100644
--- a/lib/state.ml
+++ b/lib/state.ml
@@ -4,7 +4,7 @@ open Devkit
 
 type t = {
   state : State_t.state;
-  lock : Lwt_mutex.t;
+  lock : Lwt_mutex.t;  (** protect access to mutable string map `pipeline_statuses` *)
 }
 
 let empty_repo_state () : State_t.repo_state = { pipeline_statuses = StringMap.empty }