From 7312a1710e64f4d97d8d4eb6b08ff04a589ffee1 Mon Sep 17 00:00:00 2001
From: Luke Murphy <lukewm@riseup.net>
Date: Wed, 5 Aug 2020 07:00:41 +0200
Subject: [PATCH] Add missing docstrings

---
 simple_message_channels/smc.py | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/simple_message_channels/smc.py b/simple_message_channels/smc.py
index 89f90c0..0f1e4bb 100644
--- a/simple_message_channels/smc.py
+++ b/simple_message_channels/smc.py
@@ -60,7 +60,11 @@ class SimpleMessageChannel:
             self._read_msg(data, offset)
 
     def _read_msg(self, data: bytes, offset: int) -> int:
-        """TODO."""
+        """Read a message chunk.
+
+        :param data: the message data
+        :param offset: the bytes offset
+        """
         free = len(data) - offset
 
         if free >= self.length:
@@ -79,7 +83,11 @@ class SimpleMessageChannel:
         return len(data)
 
     def _read_varint(self, data: bytes, offset: int) -> int:
-        """TODO."""
+        """Read a varint from a byte stream.
+
+        :param data: the message data
+        :param offset: the bytes offset
+        """
         while offset < len(data):
             self.varint += (data[offset] & 127) * self.factor
             self.consumed += 1
@@ -96,7 +104,11 @@ class SimpleMessageChannel:
         return len(data)
 
     def _next_state(self, data: bytes, offset: int) -> bool:
-        """TODO."""
+        """Calculate the next state.
+
+        :param data: the message data
+        :param offset: the bytes offset
+        """
         if self.state == 0:
             self.state = 1
             self.factor = 1