📝 update documentation

techouse · May 27, 2024 · 1da5567 · 1da5567
1 parent ef24fc5
commit 1da5567
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -38,7 +38,7 @@ dictionaries
        value: t.Optional[t.Union[str, t.Dict[str, t.Any]]],
        options: DecodeOptions = DecodeOptions(),
    ) -> t.Dict[str, t.Any]:
-       """Decodes a str or Dict[str, Any] into a Dict.
+       """Decodes a query string into a Dict[str, Any].
        
        Providing custom DecodeOptions will override the default behavior."""
        pass

diff --git a/docs/README.rst b/docs/README.rst
@@ -12,7 +12,7 @@ dictionaries
        value: t.Optional[t.Union[str, t.Dict[str, t.Any]]],
        options: DecodeOptions = DecodeOptions(),
    ) -> t.Dict[str, t.Any]:
-       """Decodes a str or Dict[str, Any] into a Dict.
+       """Decodes a query string into a Dict[str, Any].
        
        Providing custom DecodeOptions will override the default behavior."""
        pass

diff --git a/src/qs_codec/decode.py b/src/qs_codec/decode.py
@@ -19,7 +19,7 @@ def decode(
     options: DecodeOptions = DecodeOptions(),
 ) -> t.Dict[str, t.Any]:
     """
-    Decodes a ``str`` or ``t.Dict[str, t.Any]`` into a ``dict``.
+    Decodes a query string into a ``Dict[str, Any]``.
 
     Providing custom ``DecodeOptions`` will override the default behavior.
     """