From 1da5567e3035ec1c2c0ce091ca3412166add6350 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Klemen=20Tu=C5=A1ar?= Date: Mon, 27 May 2024 18:48:13 +0100 Subject: [PATCH] :memo: update documentation --- README.rst | 2 +- docs/README.rst | 2 +- src/qs_codec/decode.py | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 0828a62..f18d7e5 100644 --- 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 index 7b3b720..6fecd81 100644 --- 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 index 44bac3e..a38f12a 100644 --- 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. """