From eed0e35c9f036b53cbd795b08613b0f115631a6e Mon Sep 17 00:00:00 2001 From: Tianyu Liu Date: Mon, 24 Feb 2025 23:56:10 -0500 Subject: [PATCH] Add more comments --- python/kvikio/kvikio/defaults.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/python/kvikio/kvikio/defaults.py b/python/kvikio/kvikio/defaults.py index 181382cdcf..bcf6bef235 100644 --- 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)