Skip to content

Commit dc6faa2

Browse files
committed
Add docs warning
Signed-off-by: Filipe Laíns <lains@riseup.net>
1 parent a324d96 commit dc6faa2

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

Doc/library/importlib.rst

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -283,6 +283,16 @@ ABC hierarchy::
283283

284284
Returns an iterable of possible specs.
285285

286+
.. warning::
287+
This method can potentially yield a very large number of objects, and
288+
it may carry out IO operations when computing these values.
289+
290+
Because of this, it will generaly be desirable to compute the result
291+
values on-the-fly, as they are needed. As such, the returned object is
292+
only guaranteed to be an :class:`iterable <collections.abc.Iterable>`,
293+
instead of a :class:`list` or other
294+
:class:`collection <collections.abc.Collection>` type.
295+
286296
.. versionadded:: next
287297

288298

@@ -325,6 +335,16 @@ ABC hierarchy::
325335

326336
Returns an iterable of possible specs.
327337

338+
.. warning::
339+
This method can potentially yield a very large number of objects, and
340+
it may carry out IO operations when computing these values.
341+
342+
Because of this, it will generaly be desirable to compute the result
343+
values on-the-fly, as they are needed. As such, the returned object is
344+
only guaranteed to be an :class:`iterable <collections.abc.Iterable>`,
345+
instead of a :class:`list` or other
346+
:class:`collection <collections.abc.Collection>` type.
347+
328348
.. versionadded:: next
329349

330350

0 commit comments

Comments
 (0)