Add doc string to PageIterator (#2685)

boto · Jun 6, 2022 · d99b1fd · d99b1fd
1 parent 8893847
commit d99b1fd
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/botocore/paginate.py b/botocore/paginate.py
@@ -185,6 +185,11 @@ def get_paginator(self, operation_name):
 
 
 class PageIterator:
+    """An iterable object to pagiante API results.
+    Please note it is NOT a python iterator.
+    Use ``iter`` to wrap this as a generator.
+    """
+
     def __init__(
         self,
         method,