diff options
author | Nejc Habjan <hab.nejc@gmail.com> | 2021-12-01 01:03:30 +0100 |
---|---|---|
committer | Nejc Habjan <hab.nejc@gmail.com> | 2021-12-01 01:03:30 +0100 |
commit | 79e785e765f4219fe6001ef7044235b82c5e7754 (patch) | |
tree | ba7802c55cf233031b77e719cebb59639ba61f8b /gitlab/v4/objects/files.py | |
parent | af0cb4d18b8bfbc0624ea2771d73544dc1b24b54 (diff) | |
download | gitlab-docs/sphinx-annotations.tar.gz |
docs: use annotations for return typesdocs/sphinx-annotations
Diffstat (limited to 'gitlab/v4/objects/files.py')
-rw-r--r-- | gitlab/v4/objects/files.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/gitlab/v4/objects/files.py b/gitlab/v4/objects/files.py index 73a69ea..c3a8ec8 100644 --- a/gitlab/v4/objects/files.py +++ b/gitlab/v4/objects/files.py @@ -111,7 +111,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTMa GitlabGetError: If the file could not be retrieved Returns: - object: The generated RESTObject + The generated RESTObject """ return cast(ProjectFile, GetMixin.get(self, file_path, ref=ref, **kwargs)) @@ -132,7 +132,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTMa **kwargs: Extra options to send to the server (e.g. sudo) Returns: - RESTObject: a new instance of the managed object class built with + a new instance of the managed object class built with the data sent by the server Raises: @@ -165,7 +165,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTMa **kwargs: Extra options to send to the server (e.g. sudo) Returns: - dict: The new object data (*not* a RESTObject) + The new object data (*not* a RESTObject) Raises: GitlabAuthenticationError: If authentication is not correct @@ -236,7 +236,7 @@ class ProjectFileManager(GetMixin, CreateMixin, UpdateMixin, DeleteMixin, RESTMa GitlabGetError: If the file could not be retrieved Returns: - str: The file content + The file content """ file_path = file_path.replace("/", "%2F").replace(".", "%2E") path = f"{self.path}/{file_path}/raw" |