From dd8ef35174c429b75d14cbc324bd71e8c8634411 Mon Sep 17 00:00:00 2001 From: Gavin Bannerman <16233190+gbannerman@users.noreply.github.com> Date: Sun, 21 Apr 2024 16:31:05 +0100 Subject: [PATCH] Fix incorrect docstring for `to_base64` Relay util (#3467) This commit fixes the docstring for the `to_base64` function in the Relay utils module. The docstring incorrectly stated that the return type was a tuple, but it is actually the base64 encoded global ID string . --- RELEASE.md | 3 +++ strawberry/relay/utils.py | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) create mode 100644 RELEASE.md diff --git a/RELEASE.md b/RELEASE.md new file mode 100644 index 0000000000..e826757a8f --- /dev/null +++ b/RELEASE.md @@ -0,0 +1,3 @@ +Release type: patch + +This release fixes a minor issue where the docstring for the relay util `to_base64` described the return type incorrectly. diff --git a/strawberry/relay/utils.py b/strawberry/relay/utils.py index 2232429b5c..25014c7c70 100644 --- a/strawberry/relay/utils.py +++ b/strawberry/relay/utils.py @@ -41,7 +41,7 @@ def to_base64(type_: Union[str, type, StrawberryObjectDefinition], node_id: Any) The node id itself Returns: - A tuple of (TypeName, NodeID). + A GlobalID, which is a string resulting from base64 encoding :. Raises: ValueError: