docstrings

Author: martindurant

src/snappy/snappy.py

@@ -150,10 +150,9 @@ def __init__(self):
 
     @staticmethod
     def check_format(fin):
-        """Checks that the given data starts with snappy framing format
-        stream identifier.
-        Raises UncompressError if it doesn't start with the identifier.
-        :return: None
+        """Does this stream start with a stream header block?
+
+        True indicates that the stream can likely be decoded using this class.
         """
         try:
             return fin.read(len(_STREAM_HEADER_BLOCK)) == _STREAM_HEADER_BLOCK
@@ -227,9 +226,7 @@ def __init__(self):
 
     @staticmethod
     def check_format(fin):
-        """Checks that there are enough bytes for a hadoop header
-        
-        We cannot actually determine if the data is really hadoop-snappy
+        """Does this look like a hadoop snappy stream?
         """
         try:
             from snappy.snappy_formats import check_unframed_format

src/snappy/snappy_formats.py

@@ -42,6 +42,7 @@
 
 
 def uvarint(fin):
+    """Read uint64 nbumber from varint encoding in a stream"""
     result = 0
     shift = 0
     while True:
@@ -54,6 +55,11 @@ def uvarint(fin):
 
 
 def check_unframed_format(fin, reset=False):
+    """Can this be read using the raw codec
+
+    This function wil return True for all snappy raw streams, but
+    True does not mean that we can necessarily decode the stream.
+    """
     if reset:
         fin.seek(0)
     try:
@@ -81,8 +87,8 @@ def check_unframed_format(fin, reset=False):
 def guess_format_by_header(fin):
     """Tries to guess a compression format for the given input file by it's
     header.
-    :return: tuple of decompression method and a chunk that was taken from the
-        input for format detection.
+
+    :return: format name (str), stream decompress function (callable)
     """
     if StreamDecompressor.check_format(fin):
         form = "framed"