From e9b02350b2e7f313486aa909147f27dd5b0d2c34 Mon Sep 17 00:00:00 2001
From: smlng <s@mlng.net>
Date: Sat, 10 Apr 2021 20:30:53 +0200
Subject: [PATCH] docs: add and update docstrings

---
 cayennelpp/lpp_frame.py | 1 +
 cayennelpp/lpp_type.py  | 8 ++++++--
 2 files changed, 7 insertions(+), 2 deletions(-)

diff --git a/cayennelpp/lpp_frame.py b/cayennelpp/lpp_frame.py
index 6142ec4..7ad704c 100644
--- a/cayennelpp/lpp_frame.py
+++ b/cayennelpp/lpp_frame.py
@@ -7,6 +7,7 @@ class LppFrame(object):
 
     Attributes:
         data (list): a list of LppData objects
+        maxsize (int): (otpional) byte size limit
     """
 
     def __init__(self, data=None, maxsize=0):
diff --git a/cayennelpp/lpp_type.py b/cayennelpp/lpp_type.py
index dcab650..27b5ecc 100644
--- a/cayennelpp/lpp_type.py
+++ b/cayennelpp/lpp_type.py
@@ -55,7 +55,7 @@ def __init__(self, type_, name, sizes, scales, signs):
         self.signs = signs
 
     def __int__(self):
-        """Return LppType attribute as integer."""
+        """Return LppType as integer, i.e. its numeric type."""
         return self.type
 
     @staticmethod
@@ -106,7 +106,7 @@ def __to_unsigned(val):
 
     @classmethod
     def get_lpp_type(cls, type_):
-        """Returns LppType object for given type or `None` if not found."""
+        """Return LppType object for given type or `None` if not found."""
         if not isinstance(type_, int):
             raise TypeError('Parameter (type_) must be an integer!')
 
@@ -116,13 +116,16 @@ def get_lpp_type(cls, type_):
 
     @property
     def dimension(self):
+        """Return number of value dimensions."""
         return len(self.sizes)
 
     @property
     def size(self):
+        """Return size of byte string representation."""
         return sum(self.sizes)
 
     def decode(self, buf):
+        """Parse LppType from a byte string."""
         if len(buf) != sum(self.sizes):
             raise BufferError('Invalid buffer length!')
         data = []
@@ -138,6 +141,7 @@ def decode(self, buf):
         return tuple(data)
 
     def encode(self, data):
+        """Convert LppType into a byte string."""
         data = self.__assert_data_tuple(data, len(self.sizes))
         buf = bytearray(sum(self.sizes))
         pos = 0