Add errors module to docs. Add docstrings in common module.

fkdosilovic · fkdosilovic · commit c498a23f7cf3 · 2024-12-30T12:49:20.000+01:00
diff --git a/docs/source/api/errors.rst b/docs/source/api/errors.rst
@@ -0,0 +1,5 @@
+Errors Module
+=============
+
+.. automodule:: judge0.errors
+   :members:
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -60,6 +60,7 @@ Every contribution, big or small, is valuable!
       api/clients
       api/types
       api/retry
+      api/errors
 
 .. toctree::
       :caption: Getting Involved
diff --git a/src/judge0/common.py b/src/judge0/common.py
@@ -6,6 +6,7 @@
 
 
 def encode(content: Union[bytes, str, Encodeable]) -> str:
+    """Encode content to base64 string."""
     if isinstance(content, bytes):
         return b64encode(content).decode()
     if isinstance(content, str):
@@ -16,6 +17,7 @@ def encode(content: Union[bytes, str, Encodeable]) -> str:
 
 
 def decode(content: Union[bytes, str]) -> str:
+    """Decode base64 encoded content."""
     if isinstance(content, bytes):
         return b64decode(
             content.decode(errors="backslashreplace"), validate=True
