Add more comments

rapidsai · Feb 25, 2025 · eed0e35 · eed0e35
1 parent 67759f1
commit eed0e35
Showing 1 changed file with 15 additions and 1 deletion.
diff --git a/python/kvikio/kvikio/defaults.py b/python/kvikio/kvikio/defaults.py
@@ -38,8 +38,22 @@ def _set_property(self, property: str, value: Any):
 def set(*config: Any) -> ConfigContextManager:
     """Set KvikIO configurations.
 
+    Examples:
+
+    - To set one or more properties
+
+      .. code-block:: python
+
+         kvikio.defaults.set({"prop1": value1, "prop2": value2})
+
+    - To set a single property
+
+      .. code-block:: python
+
+         kvikio.defaults.set("prop", value)
+
     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)