Skip to content

Commit

Permalink
Add missing args in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Gauvain Pocentek committed Jul 17, 2016
1 parent 94aea52 commit 075345a
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions gitlab/objects.py
Expand Up @@ -917,6 +917,14 @@ def artifacts(self, streamed=False, action=None, chunk_size=1024,
def trace(self, streamed=False, action=None, chunk_size=1024, **kwargs):
"""Get the build trace.
Args:
streamed (bool): 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
data.
chunk_size (int): Size of each chunk.
Returns:
str: The trace.
Expand Down Expand Up @@ -988,6 +996,12 @@ def blob(self, filepath, streamed=False, action=None, chunk_size=1024,
Args:
filepath (str): Path of the file to request.
streamed (bool): 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
data.
chunk_size (int): Size of each chunk.
Returns:
str: The content of the file
Expand Down Expand Up @@ -1751,6 +1765,12 @@ def repository_blob(self, sha, filepath, streamed=False, action=None,
Args:
sha (str): ID of the commit
filepath (str): Path of the file to return
streamed (bool): 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
data.
chunk_size (int): Size of each chunk.
Returns:
str: The file content
Expand All @@ -1771,6 +1791,12 @@ def repository_raw_blob(self, sha, streamed=False, action=None,
Args:
sha(str): ID of the blob
streamed (bool): 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
data.
chunk_size (int): Size of each chunk.
Returns:
str: The blob content
Expand Down Expand Up @@ -1831,6 +1857,12 @@ def repository_archive(self, sha=None, streamed=False, action=None,
Args:
sha (str): ID of the commit (default branch by default).
streamed (bool): 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
data.
chunk_size (int): Size of each chunk.
Returns:
str: The binary data of the archive.
Expand Down

0 comments on commit 075345a

Please sign in to comment.