Update docs

vitessce · Aug 2, 2024 · eb7fc24 · eb7fc24
1 parent 5e61704
commit eb7fc24
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 12 deletions.
diff --git a/.coveragerc_omit b/.coveragerc_omit
@@ -11,4 +11,5 @@ omit =
     vitessce/data_utils/ome.py
     vitessce/data_utils/entities.py
     vitessce/data_utils/multivec.py
-    vitessce/widget_plugins/demo_plugin.py
+    vitessce/widget_plugins/demo_plugin.py
+    vitessce/widget_plugins/spatial_query_plugin.py
diff --git a/docs/widget_plugins.rst b/docs/widget_plugins.rst
@@ -47,24 +47,21 @@ If defined, these plugin arrays are passed to the Vitessce component as `props <
 Passing plugin ESM to the widget
 --------------------------------
 
-The plugin string can be passed to the widget using the ``plugin_esm`` parameter:
+The plugin string can be passed to the widget using the ``plugins`` parameter and passing a subclass of ``VitesscePlugin``:
 
 
 .. code-block:: python
 
-    from vitessce import VitessceConfig
+    from vitessce import VitessceConfig, VitesscePlugin
 
-    vc = VitessceConfig(
-        description="A Vitessce widget with a custom plugin",
-        widget=[
-            {
-                "plugin": PLUGIN_ESM,
-            },
-        ],
-    )
+    class MyPlugin(VitesscePlugin):
+        plugin_esm = PLUGIN_ESM
+
+    vc = VitessceConfig(description="A Vitessce widget with a custom plugin")
     # Some more configuration here...
 
-    vc.widget(plugin_esm=PLUGIN_ESM)
+    plugin = MyPlugin()
+    vc.widget(plugins=[plugin])
 
 
 -------------------------------
@@ -149,4 +146,7 @@ vitessce.widget_plugins
 ***********************
 
 .. automodule:: vitessce.widget_plugins.demo_plugin
+ :members:
+
+.. automodule:: vitessce.widget_plugins.spatial_query
  :members: