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 .
strawberry-graphql · Apr 21, 2024 · dd8ef35 · dd8ef35
1 parent 79b440f
commit dd8ef35
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/RELEASE.md 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
@@ -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 <TypeName>:<NodeID>.
 
     Raises:
         ValueError:
Original file line number	Diff line number	Diff line change
		@@ -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.