Documentation

1 files changed, 10 insertions, 1 deletions

diff --git a/trade_queue.py b/trade_queue.py
index a23d8e8..c76017a 100644
--- a/trade_queue.py
+++ b/trade_queue.py
@@ -18,15 +18,24 @@ class FIFOQueue:
     """
 
     def __init__(self) -> None:
+        """
+        Create new FIFO queue holding cryptocurrency trades.
+        """
         self.__queue: Deque[Trade] = deque()
         self._cached_total: Decimal = Decimal(0)
         self._cache_valid: bool = True
         logger.info("FIFOQueue initialized with empty queue.")
 
     def __len__(self) -> int:
+        """
+        Get amount of trades in the queue.
+        """
         return len(self.__queue)
     
     def __repr__(self) -> str:
+        """
+        Get string representation of queue (for debugging).
+        """
         return f"FIFOQueue(len={len(self)})"
 
     def get_copy(self) -> List[Trade]:
@@ -37,7 +46,7 @@ class FIFOQueue:
 
     def add(self, amount: Decimal, total_cost: Decimal, date: str) -> None:
         """
-        Add a trade to the queue.
+        Add a trade to the queue by specifying properties.
         """
         trade = Trade(amount, total_cost, date)
         self.__queue.append(trade)