diff options
author | Nejc Habjan <hab.nejc@gmail.com> | 2021-11-24 20:52:28 +0100 |
---|---|---|
committer | Nejc Habjan <hab.nejc@gmail.com> | 2021-11-28 18:31:59 +0100 |
commit | b7dde0d7aac8dbaa4f47f9bfb03fdcf1f0b01c41 (patch) | |
tree | ddf38afd58c7f1dcd538667dd952122448289bb6 /gitlab/v4/objects/snippets.py | |
parent | bd366ab9e4b552fb29f7a41564cc180a659bba2f (diff) | |
download | gitlab-b7dde0d7aac8dbaa4f47f9bfb03fdcf1f0b01c41.tar.gz |
docs: only use type annotations for documentation
Diffstat (limited to 'gitlab/v4/objects/snippets.py')
-rw-r--r-- | gitlab/v4/objects/snippets.py | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/gitlab/v4/objects/snippets.py b/gitlab/v4/objects/snippets.py index 96b80c4..08fffb9 100644 --- a/gitlab/v4/objects/snippets.py +++ b/gitlab/v4/objects/snippets.py @@ -35,12 +35,12 @@ class Snippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObject): """Return the content of a snippet. Args: - streamed (bool): If True the data will be processed by chunks of + streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment. - action (callable): Callable responsible of dealing with chunk of + action: Callable responsible of dealing with chunk of data - chunk_size (int): Size of each chunk + chunk_size: Size of each chunk **kwargs: Extra options to send to the server (e.g. sudo) Raises: @@ -74,7 +74,7 @@ class SnippetManager(CRUDMixin, RESTManager): """List all the public snippets. Args: - all (bool): If True the returned object will be a list + all: If True the returned object will be a list **kwargs: Extra options to send to the server (e.g. sudo) Raises: @@ -109,12 +109,12 @@ class ProjectSnippet(UserAgentDetailMixin, SaveMixin, ObjectDeleteMixin, RESTObj """Return the content of a snippet. Args: - streamed (bool): If True the data will be processed by chunks of + streamed: If True the data will be processed by chunks of `chunk_size` and each chunk is passed to `action` for treatment. - action (callable): Callable responsible of dealing with chunk of + action: Callable responsible of dealing with chunk of data - chunk_size (int): Size of each chunk + chunk_size: Size of each chunk **kwargs: Extra options to send to the server (e.g. sudo) Raises: |