add comments

ahrefs · Jan 10, 2022 · 9697bed · 9697bed
1 parent 1792647
commit 9697bed
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git 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
@@ -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 }