rename and add docs for define_module widget

Author: rmorshea

idom/widgets/__init__.py

@@ -1,4 +1,4 @@
-from .common import Import, import_module, hotswap
+from .common import Import, define_module, hotswap
 from .display import display
 from .inputs import Input
 from .images import Image
@@ -8,7 +8,7 @@
     "display",
     "node",
     "Image",
-    "import_module",
+    "define_module",
     "hotswap",
     "html",
     "Input",

idom/widgets/common.py

@@ -7,7 +7,23 @@
 from idom.tools import Var
 
 
-def import_module(name: str, source: Any, raw: bool = False) -> "Import":
+def define_module(name: str, source: Any, raw: bool = False) -> "Import":
+    """Add a module to the client
+
+    Parameters:
+        name:
+            What the module will be named (excluding the ``.js`` file extension). This
+            matters if you want to import this module from another later since this will
+            be the filename the module is saved under.
+        source:
+            The module's source.
+        raw:
+            If false, then ``source`` should be a file path to the module's source.
+            If true, this should be the literal source code for the module.
+
+    Returns:
+        An :class:`Import` element for the newly defined module.
+    """
     if not raw:
         with open(str(source), "r") as f:
             source = f.read()

tests/test_browser/test_client.py

@@ -4,7 +4,7 @@
 
 import pytest
 
-from idom.widgets import Import, import_module
+from idom.widgets import Import, define_module
 from idom import client
 
 HERE = Path(__file__).parent
@@ -30,7 +30,7 @@ def test_raise_on_missing_import_path():
 
 
 def test_custom_module(driver, display, victory):
-    my_chart = import_module("my_chart", HERE / "my_chart.js")
+    my_chart = define_module("my_chart", HERE / "my_chart.js")
 
     display(my_chart.Chart)