Merge branch 'compressor' of...

Merge branch 'compressor' of https://gitlab.stud.idi.ntnu.no/bachelor-paa-bittet/soitool into compressor

soitool/compressor.py

@@ -9,7 +9,7 @@ def compress(obj):
     """
     Compress a json compatible object using the lzma algorithm.
 
-    JSON compapitle object are python types that are posible to convert to
+    JSON compatible object are python types that are possible to convert to
     JSON types. Se overview in this link:
     https://docs.python.org/3/library/json.html#py-to-json-table
 
@@ -30,7 +30,7 @@ def compress(obj):
 
 def decompress(lzma_compressed_json_string):
     """
-    Decompress a lzma compressed json string.
+    Decompress a lzma-compressed json string.
 
     Decompresses a json compatible python object which is casted from bytes to
     string.
@@ -38,7 +38,7 @@ def decompress(lzma_compressed_json_string):
     Parameters
     ----------
     lzma_compressed_json_string : string
-        The string of the compressed object
+        The string of the lzma-compressed json string
 
     Returns
     -------
@@ -46,7 +46,7 @@ def decompress(lzma_compressed_json_string):
         One of these python objects:
         https://docs.python.org/3/library/json.html#py-to-json-table
     """
-    # Removes extra b' notation
+    # Remove extra b' notation
     lzma_compressed_json_string = lzma_compressed_json_string[2:-1].encode(
         encoding="ascii"
     )