Skip to content

Commit

Permalink
update API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kecnry committed Mar 6, 2024
1 parent 884f3c6 commit 6681c0e
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion jdaviz/configs/default/plugins/export/export.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,18 @@
class Export(PluginTemplateMixin, ViewerSelectMixin, SubsetSelectMixin,
DatasetMultiSelectMixin, MultiselectMixin):
"""
See the :ref:`Export Plugin Documentation <export>` for more details.
See the :ref:`Export Plugin Documentation <imviz-export-plot>` for more details.
Only the following attributes and methods are available through the
:ref:`public plugin API <plugin-apis>`:
* :meth:`~jdaviz.core.template_mixin.PluginTemplateMixin.show`
* :meth:`~jdaviz.core.template_mixin.PluginTemplateMixin.open_in_tray`
* :meth:`~jdaviz.core.template_mixin.PluginTemplateMixin.close_in_tray`
* ``viewer`` (:class:`~jdaviz.core.template_mixin.ViewerSelect`)
* ``viewer_format`` (:class:`~jdaviz.core.template_mixin.SelectPluginComponent`)
* ``filename``
* :meth:`export`
"""
template_file = __file__, "export.vue"

Expand Down

0 comments on commit 6681c0e

Please sign in to comment.