From acd9b157b9425cf63e87ac377aad38d071b0f3f3 Mon Sep 17 00:00:00 2001
From: Yohann D'ANELLO <ynerant@crans.org>
Date: Tue, 5 Jan 2021 22:36:09 +0100
Subject: [PATCH] Add docstring for the update table function

---
 squinnondation/hazel.py | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/squinnondation/hazel.py b/squinnondation/hazel.py
index 0c5ff2f..59f03d2 100644
--- a/squinnondation/hazel.py
+++ b/squinnondation/hazel.py
@@ -697,6 +697,10 @@ class Squirrel(Hazelnut):
                 self.update_hazelnut_table(hazelnut)
 
     def update_hazelnut_table(self, hazelnut: Hazelnut) -> None:
+        """
+        We insert the hazelnut into our table of clients.
+        If there is a collision with the address / the ID, then we merge clients into a unique one.
+        """
         for addr in hazelnut.addresses:
             if addr in self.hazelnuts:
                 # Merge with the previous hazel