File tree 2 files changed +8
-1
lines changed
2 files changed +8
-1
lines changed Original file line number Diff line number Diff line change @@ -85,7 +85,6 @@ if [[ -z "$CHECK" || "$CHECK" == "docstrings" ]]; then
85
85
-i " pandas.Timestamp.resolution PR02" \
86
86
-i " pandas.Timestamp.tzinfo GL08" \
87
87
-i " pandas.Timestamp.year GL08" \
88
- -i " pandas.api.types.is_iterator PR07,SA01" \
89
88
-i " pandas.api.types.is_re_compilable PR07,SA01" \
90
89
-i " pandas.api.types.pandas_dtype PR07,RT03,SA01" \
91
90
-i " pandas.arrays.ArrowExtensionArray PR07,SA01" \
Original file line number Diff line number Diff line change @@ -259,15 +259,23 @@ def is_iterator(obj: object) -> bool:
259
259
Check if the object is an iterator.
260
260
261
261
This is intended for generators , not list-like objects.
262
+ This method checks whether the passed object is an iterator. It
263
+ returns `True` if the object is an iterator , and `False` otherwise.
262
264
263
265
Parameters
264
266
----------
265
267
obj : The object to check
268
+ The object to check for iterator type.
266
269
267
270
Returns
268
271
-------
269
272
is_iter : bool
270
273
Whether `obj` is an iterator.
274
+ `True` if the object is of iterator type , otherwise `False`.
275
+
276
+ See Also
277
+ --------
278
+ api.types.is_list_like : Check if the input is list-like.
271
279
272
280
Examples
273
281
--------
You can’t perform that action at this time.
0 commit comments