fix: correct ProjectFile.decode() documentation

JohnVillalovos · JohnVillalovos · commit b180bafdf282 · 2021-04-22T18:48:54.000-07:00
ProjectFile.decode() returns 'bytes' and not 'str'. Update the method's doc-string and add a type-hint. ProjectFile.decode() returns the result of a call to base64.b64decode() The docs for that function state it returns 'bytes': https://docs.python.org/3/library/base64.html#base64.b64decode Fixes: #1403
diff --git a/gitlab/v4/objects/files.py b/gitlab/v4/objects/files.py
@@ -22,11 +22,11 @@ class ProjectFile(SaveMixin, ObjectDeleteMixin, RESTObject):
     _id_attr = "file_path"
     _short_print_attr = "file_path"
 
-    def decode(self):
+    def decode(self) -> bytes:
         """Returns the decoded content of the file.
 
         Returns:
-            (str): the decoded content.
+            (bytes): the decoded content.
         """
         return base64.b64decode(self.content)
 
