Skip to content

Commit 075345a

Browse files
author
Gauvain Pocentek
committed
Add missing args in docstrings
1 parent 94aea52 commit 075345a

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

gitlab/objects.py

+32
Original file line numberDiff line numberDiff line change
@@ -917,6 +917,14 @@ def artifacts(self, streamed=False, action=None, chunk_size=1024,
917917
def trace(self, streamed=False, action=None, chunk_size=1024, **kwargs):
918918
"""Get the build trace.
919919
920+
Args:
921+
streamed (bool): If True the data will be processed by chunks of
922+
`chunk_size` and each chunk is passed to `action` for
923+
treatment.
924+
action (callable): Callable responsible of dealing with chunk of
925+
data.
926+
chunk_size (int): Size of each chunk.
927+
920928
Returns:
921929
str: The trace.
922930
@@ -988,6 +996,12 @@ def blob(self, filepath, streamed=False, action=None, chunk_size=1024,
988996
989997
Args:
990998
filepath (str): Path of the file to request.
999+
streamed (bool): If True the data will be processed by chunks of
1000+
`chunk_size` and each chunk is passed to `action` for
1001+
treatment.
1002+
action (callable): Callable responsible of dealing with chunk of
1003+
data.
1004+
chunk_size (int): Size of each chunk.
9911005
9921006
Returns:
9931007
str: The content of the file
@@ -1751,6 +1765,12 @@ def repository_blob(self, sha, filepath, streamed=False, action=None,
17511765
Args:
17521766
sha (str): ID of the commit
17531767
filepath (str): Path of the file to return
1768+
streamed (bool): If True the data will be processed by chunks of
1769+
`chunk_size` and each chunk is passed to `action` for
1770+
treatment.
1771+
action (callable): Callable responsible of dealing with chunk of
1772+
data.
1773+
chunk_size (int): Size of each chunk.
17541774
17551775
Returns:
17561776
str: The file content
@@ -1771,6 +1791,12 @@ def repository_raw_blob(self, sha, streamed=False, action=None,
17711791
17721792
Args:
17731793
sha(str): ID of the blob
1794+
streamed (bool): If True the data will be processed by chunks of
1795+
`chunk_size` and each chunk is passed to `action` for
1796+
treatment.
1797+
action (callable): Callable responsible of dealing with chunk of
1798+
data.
1799+
chunk_size (int): Size of each chunk.
17741800
17751801
Returns:
17761802
str: The blob content
@@ -1831,6 +1857,12 @@ def repository_archive(self, sha=None, streamed=False, action=None,
18311857
18321858
Args:
18331859
sha (str): ID of the commit (default branch by default).
1860+
streamed (bool): If True the data will be processed by chunks of
1861+
`chunk_size` and each chunk is passed to `action` for
1862+
treatment.
1863+
action (callable): Callable responsible of dealing with chunk of
1864+
data.
1865+
chunk_size (int): Size of each chunk.
18341866
18351867
Returns:
18361868
str: The binary data of the archive.

0 commit comments

Comments
 (0)