docs: Document missing initializers for authentication and pagination…

… helpers (#950)
meltano · Sep 7, 2022 · 6c7b5fd · 6c7b5fd
1 parent 41b00cc
commit 6c7b5fd
Show file tree

Hide file tree

Showing 12 changed files with 24 additions and 12 deletions.
diff --git a/docs/classes/singer_sdk.authenticators.APIAuthenticatorBase.rst b/docs/classes/singer_sdk.authenticators.APIAuthenticatorBase.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.authenticators
 
 .. autoclass:: APIAuthenticatorBase
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.exceptions.RecordsWithoutSchemaException.rst b/docs/classes/singer_sdk.exceptions.RecordsWithoutSchemaException.rst
@@ -1,7 +1,8 @@
 singer_sdk.exceptions.RecordsWithoutSchemaException
-==================================================
+===================================================
 
 .. currentmodule:: singer_sdk.exceptions
 
 .. autoclass:: RecordsWithoutSchemaException
     :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.BaseAPIPaginator.rst b/docs/classes/singer_sdk.pagination.BaseAPIPaginator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: BaseAPIPaginator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.BaseHATEOASPaginator.rst b/docs/classes/singer_sdk.pagination.BaseHATEOASPaginator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: BaseHATEOASPaginator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.BaseOffsetPaginator.rst b/docs/classes/singer_sdk.pagination.BaseOffsetPaginator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: BaseOffsetPaginator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.BasePageNumberPaginator.rst b/docs/classes/singer_sdk.pagination.BasePageNumberPaginator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: BasePageNumberPaginator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.HeaderLinkPaginator.rst b/docs/classes/singer_sdk.pagination.HeaderLinkPaginator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: HeaderLinkPaginator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.JSONPathPaginator.rst b/docs/classes/singer_sdk.pagination.JSONPathPaginator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: JSONPathPaginator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.LegacyPaginatedStreamProtocol.rst b/docs/classes/singer_sdk.pagination.LegacyPaginatedStreamProtocol.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: LegacyPaginatedStreamProtocol
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.LegacyStreamPaginator.rst b/docs/classes/singer_sdk.pagination.LegacyStreamPaginator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: LegacyStreamPaginator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.SimpleHeaderPaginator.rst b/docs/classes/singer_sdk.pagination.SimpleHeaderPaginator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: SimpleHeaderPaginator
-    :members:
+    :members:
+    :special-members: __init__
diff --git a/docs/classes/singer_sdk.pagination.SinglePagePaginator.rst b/docs/classes/singer_sdk.pagination.SinglePagePaginator.rst
@@ -4,4 +4,5 @@
 .. currentmodule:: singer_sdk.pagination
 
 .. autoclass:: SinglePagePaginator
-    :members:
+    :members:
+    :special-members: __init__