🎨 Update docstrings

Signed-off-by: ff137 <[email protected]>

Author: ff137

nats/json_util.py

@@ -10,12 +10,20 @@
 
 
 class JsonUtil:
-    """A utility class for handling JSON-related operations.
-    This class provides static methods for formatting JSON strings, and
-    for converting between Python objects and JSON strings/files. It uses
-    the `orjson` library where possible for its speed advantages, but reverts
-    to the standard `json` library where `orjson` does not support the required
-    functionality.
+    """A utility class for handling JSON serialization operations.
+    This class provides static methods for converting between Python objects and JSON
+    strings/bytes. It uses the `orjson` library when available for its performance
+    advantages, falling back to the standard `json` library when `orjson` is not
+    installed.
+
+    The class handles compatibility between the two libraries, particularly for options
+    like 'sort_keys' which have different implementations in each library. All methods
+    maintain consistent behavior regardless of which JSON library is being used.
+
+    Methods:
+        dumps(obj, *args, **kwargs) -> str: Converts object to JSON string
+        dump_bytes(obj, *args, **kwargs) -> bytes: Converts object to JSON bytes
+        loads(s, *args, **kwargs) -> Any: Parses JSON string into Python object
     """
 
     @staticmethod
@@ -24,7 +32,7 @@ def _handle_sort_keys(kwargs):
         Args:
             kwargs: The keyword arguments dictionary to modify
         Returns:
-            Modified kwargs dictionary
+            Modified kwargs dictionary with orjson-compatible options
         """
         if kwargs.pop("sort_keys", False):
             option = kwargs.get("option", 0) | orjson.OPT_SORT_KEYS
@@ -33,15 +41,15 @@ def _handle_sort_keys(kwargs):
 
     @staticmethod
     def dumps(obj, *args, **kwargs) -> str:
-        """Convert a Python object into a json string.
+        """Convert a Python object into a JSON string.
         Args:
             obj: The data to be converted
             *args: Extra arguments to pass to the dumps() function
             **kwargs: Extra keyword arguments to pass to the dumps() function.
                      Special handling for 'sort_keys' which is translated to
                      orjson.OPT_SORT_KEYS when using orjson.
         Returns:
-            The json string representation of obj
+            str: A JSON string representation of obj
         """
         if orjson is None:
             return json.dumps(obj, *args, **kwargs)
@@ -51,15 +59,15 @@ def dumps(obj, *args, **kwargs) -> str:
 
     @staticmethod
     def dump_bytes(obj, *args, **kwargs) -> bytes:
-        """Convert a Python object into a bytes string.
+        """Convert a Python object into a JSON bytes string.
         Args:
             obj: The data to be converted
             *args: Extra arguments to pass to the dumps() function
             **kwargs: Extra keyword arguments to pass to the dumps() function.
                      Special handling for 'sort_keys' which is translated to
                      orjson.OPT_SORT_KEYS when using orjson.
         Returns:
-            The json string representation of obj as bytes
+            bytes: A JSON bytes string representation of obj
         """
         if orjson is None:
             return json.dumps(obj, *args, **kwargs).encode("utf-8")