add docstring to __init__.py

This commit is contained in:
Eric Trombly
2020-04-14 10:44:15 -05:00
parent 7fe094ac02
commit 7bd2ec425e

View File

@@ -0,0 +1,13 @@
"""
LazyLoader will defer import of a module until first usage. Usage:
from lazy_loader.lazy_loader import LazyLoader
numpy = LazyLoader("numpy", globals(), "numpy")
or
whatever = LazyLoader("module", globals(), "module.whatever")
or to replicate import module as something
something = LazyLoader("module", globals(), "module")
"""