From 2246d28606f166087a18e963d4407903b8833e38 Mon Sep 17 00:00:00 2001
From: "Antoine R. Dumont (@ardumont)" <ardumont@softwareheritage.org>
Date: Mon, 25 Jan 2021 13:29:40 +0100
Subject: [PATCH] gitlab: Document the lister constructor parameters

Related to T2987
---
 swh/lister/gitlab/lister.py | 13 ++++++++++---
 1 file changed, 10 insertions(+), 3 deletions(-)

diff --git a/swh/lister/gitlab/lister.py b/swh/lister/gitlab/lister.py
index 6e69a4b..04bcbe2 100644
--- a/swh/lister/gitlab/lister.py
+++ b/swh/lister/gitlab/lister.py
@@ -79,6 +79,13 @@ class GitLabLister(Lister[GitLabListerState, PageResult]):
     By default, the lister runs in incremental mode: it lists all repositories,
     starting with the `last_seen_next_link` stored in the scheduler backend.
 
+    Args:
+        scheduler: a scheduler instance
+        url: the api v4 url of the gitlab instance to visit (e.g.
+          https://gitlab.com/api/v4/)
+        instance: a specific instance name (e.g. gitlab, tor, git-kernel, ...)
+        incremental: defines if incremental listing is activated or not
+
     """
 
     LISTER_NAME = "gitlab"
@@ -86,9 +93,9 @@ class GitLabLister(Lister[GitLabListerState, PageResult]):
     def __init__(
         self,
         scheduler,
-        url=None,
-        instance=None,
-        credentials: CredentialsType = None,
+        url: Optional[str] = None,
+        instance: Optional[str] = None,
+        credentials: Optional[CredentialsType] = None,
         incremental: bool = False,
     ):
         if instance is None: