Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitf62dda7

Browse files
igorp-collaboranejch
authored andcommitted
docs: Use get_all keyword arg instead of all in docstrings
The `all` keyword had a lot of conflicts with other API parametersand was silently deprecated in favour of `get_all`. However,a lot of docstings were not updated to use the new keyword.Signed-off-by: Igor Ponomarev <igor.ponomarev@collabora.com>
1 parentbefba35 commitf62dda7

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

‎gitlab/mixins.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ def list(
168168
"""Retrieve a list of objects.
169169
170170
Args:
171-
all: If True, return all the items, without pagination
171+
get_all: If True, return all the items, without pagination
172172
per_page: Number of items to retrieve per request
173173
page: ID of the page to return (starts with page 1)
174174
iterator: If set to True and no pagination option is
@@ -867,7 +867,7 @@ def participants(
867867
"""List the participants.
868868
869869
Args:
870-
all: If True, return all the items, without pagination
870+
get_all: If True, return all the items, without pagination
871871
per_page: Number of items to retrieve per request
872872
page: ID of the page to return (starts with page 1)
873873
**kwargs: Extra options to send to the server (e.g. sudo)

‎gitlab/v4/objects/ldap.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ def list(self, **kwargs: Any) -> list[LDAPGroup] | RESTObjectList[LDAPGroup]:
2222
"""Retrieve a list of objects.
2323
2424
Args:
25-
all: If True, return all the items, without pagination
25+
get_all: If True, return all the items, without pagination
2626
per_page: Number of items to retrieve per request
2727
page: ID of the page to return (starts with page 1)
2828
iterator: If set to True and no pagination option is

‎gitlab/v4/objects/merge_requests.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ def related_issues(self, **kwargs: Any) -> RESTObjectList[ProjectIssue]:
207207
"""List issues related to this merge request."
208208
209209
Args:
210-
all: If True, return all the items, without pagination
210+
get_all: If True, return all the items, without pagination
211211
per_page: Number of items to retrieve per request
212212
page: ID of the page to return (starts with page 1)
213213
**kwargs: Extra options to send to the server (e.g. sudo)
@@ -236,7 +236,7 @@ def closes_issues(self, **kwargs: Any) -> RESTObjectList[ProjectIssue]:
236236
"""List issues that will close on merge."
237237
238238
Args:
239-
all: If True, return all the items, without pagination
239+
get_all: If True, return all the items, without pagination
240240
per_page: Number of items to retrieve per request
241241
page: ID of the page to return (starts with page 1)
242242
**kwargs: Extra options to send to the server (e.g. sudo)
@@ -261,7 +261,7 @@ def commits(self, **kwargs: Any) -> RESTObjectList[ProjectCommit]:
261261
"""List the merge request commits.
262262
263263
Args:
264-
all: If True, return all the items, without pagination
264+
get_all: If True, return all the items, without pagination
265265
per_page: Number of items to retrieve per request
266266
page: ID of the page to return (starts with page 1)
267267
**kwargs: Extra options to send to the server (e.g. sudo)

‎gitlab/v4/objects/milestones.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ def issues(self, **kwargs: Any) -> RESTObjectList[GroupIssue]:
3939
"""List issues related to this milestone.
4040
4141
Args:
42-
all: If True, return all the items, without pagination
42+
get_all: If True, return all the items, without pagination
4343
per_page: Number of items to retrieve per request
4444
page: ID of the page to return (starts with page 1)
4545
**kwargs: Extra options to send to the server (e.g. sudo)
@@ -66,7 +66,7 @@ def merge_requests(self, **kwargs: Any) -> RESTObjectList[GroupMergeRequest]:
6666
"""List the merge requests related to this milestone.
6767
6868
Args:
69-
all: If True, return all the items, without pagination
69+
get_all: If True, return all the items, without pagination
7070
per_page: Number of items to retrieve per request
7171
page: ID of the page to return (starts with page 1)
7272
**kwargs: Extra options to send to the server (e.g. sudo)
@@ -113,7 +113,7 @@ def issues(self, **kwargs: Any) -> RESTObjectList[ProjectIssue]:
113113
"""List issues related to this milestone.
114114
115115
Args:
116-
all: If True, return all the items, without pagination
116+
get_all: If True, return all the items, without pagination
117117
per_page: Number of items to retrieve per request
118118
page: ID of the page to return (starts with page 1)
119119
**kwargs: Extra options to send to the server (e.g. sudo)
@@ -140,7 +140,7 @@ def merge_requests(self, **kwargs: Any) -> RESTObjectList[ProjectMergeRequest]:
140140
"""List the merge requests related to this milestone.
141141
142142
Args:
143-
all: If True, return all the items, without pagination
143+
get_all: If True, return all the items, without pagination
144144
per_page: Number of items to retrieve per request
145145
page: ID of the page to return (starts with page 1)
146146
**kwargs: Extra options to send to the server (e.g. sudo)

‎gitlab/v4/objects/repositories.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ def repository_tree(
6464
path: Path of the top folder (/ by default)
6565
ref: Reference to a commit or branch
6666
recursive: Whether to get the tree recursively
67-
all: If True, return all the items, without pagination
67+
get_all: If True, return all the items, without pagination
6868
per_page: Number of items to retrieve per request
6969
page: ID of the page to return (starts with page 1)
7070
iterator: If set to True and no pagination option is
@@ -218,7 +218,7 @@ def repository_contributors(
218218
"""Return a list of contributors for the project.
219219
220220
Args:
221-
all: If True, return all the items, without pagination
221+
get_all: If True, return all the items, without pagination
222222
per_page: Number of items to retrieve per request
223223
page: ID of the page to return (starts with page 1)
224224
iterator: If set to True and no pagination option is

‎gitlab/v4/objects/runners.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ def all(self, scope: str | None = None, **kwargs: Any) -> list[Runner]:
8484
Args:
8585
scope: The scope of runners to show, one of: specific,
8686
shared, active, paused, online
87-
all: If True, return all the items, without pagination
87+
get_all: If True, return all the items, without pagination
8888
per_page: Number of items to retrieve per request
8989
page: ID of the page to return (starts with page 1)
9090
iterator: If set to True and no pagination option is

‎gitlab/v4/objects/users.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -627,7 +627,7 @@ def list(self, **kwargs: Any) -> RESTObjectList[UserProject] | list[UserProject]
627627
"""Retrieve a list of objects.
628628
629629
Args:
630-
all: If True, return all the items, without pagination
630+
get_all: If True, return all the items, without pagination
631631
per_page: Number of items to retrieve per request
632632
page: ID of the page to return (starts with page 1)
633633
iterator: If set to True and no pagination option is

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp