Add more comments

rapidsai · Feb 24, 2025 · 67759f1 · 67759f1
1 parent 8f53d5f
commit 67759f1
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/python/kvikio/kvikio/defaults.py b/python/kvikio/kvikio/defaults.py
@@ -36,6 +36,16 @@ def _set_property(self, property: str, value: Any):
 
 
 def set(*config: Any) -> ConfigContextManager:
+    """Set KvikIO configurations.
+
+    Parameters
+    -------
+    Any
+        The configurations. Can either be a single parameter (dict) consisting of one
+        or more properties, or two parameters key (string) and value (Any)
+        indicating a single property.
+    """
+
     err_msg = (
         "Valid arguments are kvikio.defaults.set(config: dict) or "
         "kvikio.defaults.set(key: str, value: Any)"