From e90ba1e44aa7624ebd58fadad7141fddfdb69130 Mon Sep 17 00:00:00 2001
From: Lee Miller <lee.miller@tutanota.com>
Date: Thu, 24 Oct 2024 21:24:54 +0300
Subject: [PATCH] Document the main proofofwork call

---
 minode/proofofwork.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/minode/proofofwork.py b/minode/proofofwork.py
index f8aa69f..c878b2a 100644
--- a/minode/proofofwork.py
+++ b/minode/proofofwork.py
@@ -50,5 +50,10 @@ def _worker(obj):
 
 
 def do_pow_and_publish(obj):
+    """
+    Start a worker thread, doing PoW for the given object
+    and putting a new object and its vector into appropriate places in `shared`
+    to advertize to the network.
+    """
     t = threading.Thread(target=_worker, args=(obj, ))
     t.start()