Commit f62dda7f authored by Igor Ponomarev's avatar Igor Ponomarev Committed by Nejc Habjan
Browse files

docs: Use get_all keyword arg instead of all in docstrings 



The `all` keyword had a lot of conflicts with other API parameters
and was silently deprecated in favour of `get_all`. However,
a lot of docstings were not updated to use the new keyword.

Signed-off-by: default avatarIgor Ponomarev <igor.ponomarev@collabora.com>
parent befba35a

gitlab/mixins.py

+2 −2
Original line number Diff line number Diff line
@@ -168,7 +168,7 @@ class ListMixin(HeadMixin[base.TObjCls]): 
        """Retrieve a list of objects.



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            iterator: If set to True and no pagination option is
@@ -867,7 +867,7 @@ class ParticipantsMixin(_RestObjectBase): 
        """List the participants.



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            **kwargs: Extra options to send to the server (e.g. sudo)

gitlab/v4/objects/ldap.py

+1 −1
Original line number Diff line number Diff line
@@ -22,7 +22,7 @@ class LDAPGroupManager(RESTManager[LDAPGroup]): 
        """Retrieve a list of objects.



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            iterator: If set to True and no pagination option is

gitlab/v4/objects/merge_requests.py

+3 −3
Original line number Diff line number Diff line
@@ -207,7 +207,7 @@ class ProjectMergeRequest( 
        """List issues related to this merge request."



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            **kwargs: Extra options to send to the server (e.g. sudo)
@@ -236,7 +236,7 @@ class ProjectMergeRequest( 
        """List issues that will close on merge."



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            **kwargs: Extra options to send to the server (e.g. sudo)
@@ -261,7 +261,7 @@ class ProjectMergeRequest( 
        """List the merge request commits.



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            **kwargs: Extra options to send to the server (e.g. sudo)

gitlab/v4/objects/milestones.py

+4 −4
Original line number Diff line number Diff line
@@ -39,7 +39,7 @@ class GroupMilestone(SaveMixin, ObjectDeleteMixin, RESTObject): 
        """List issues related to this milestone.



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            **kwargs: Extra options to send to the server (e.g. sudo)
@@ -66,7 +66,7 @@ class GroupMilestone(SaveMixin, ObjectDeleteMixin, RESTObject): 
        """List the merge requests related to this milestone.



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            **kwargs: Extra options to send to the server (e.g. sudo)
@@ -113,7 +113,7 @@ class ProjectMilestone(PromoteMixin, SaveMixin, ObjectDeleteMixin, RESTObject): 
        """List issues related to this milestone.



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            **kwargs: Extra options to send to the server (e.g. sudo)
@@ -140,7 +140,7 @@ class ProjectMilestone(PromoteMixin, SaveMixin, ObjectDeleteMixin, RESTObject): 
        """List the merge requests related to this milestone.



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            **kwargs: Extra options to send to the server (e.g. sudo)

gitlab/v4/objects/repositories.py

+2 −2
Original line number Diff line number Diff line
@@ -64,7 +64,7 @@ class RepositoryMixin(_RestObjectBase): 
            path: Path of the top folder (/ by default)

            ref: Reference to a commit or branch

            recursive: Whether to get the tree recursively

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            iterator: If set to True and no pagination option is
@@ -218,7 +218,7 @@ class RepositoryMixin(_RestObjectBase): 
        """Return a list of contributors for the project.



        Args:

            all: If True, return all the items, without pagination

            get_all: If True, return all the items, without pagination

            per_page: Number of items to retrieve per request

            page: ID of the page to return (starts with page 1)

            iterator: If set to True and no pagination option is