From f14f05905d19be1316e574929b1a63b1ba788d17 Mon Sep 17 00:00:00 2001 From: anjakefala Date: Tue, 28 Nov 2023 23:09:46 -0800 Subject: [PATCH] Remove references to __version__ and correct plugin installation info --- docs/api/plugins.rst | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/docs/api/plugins.rst b/docs/api/plugins.rst index edb422278..e5a52bef0 100644 --- a/docs/api/plugins.rst +++ b/docs/api/plugins.rst @@ -14,7 +14,8 @@ The actual code in either case should be identical. .. note:: - At startup, all .py files placed in the ``$HOME/.visidata/`` directory or Python code added to a ``~/.visidatarc`` will be auto-imported into VisiData. + To quickly install a personal plugin, place the plugin in the ``$HOME/.visidata/plugins/`` directory, and add an ``import`` statement to ``$HOME/.visidata/plugins/__init__.py``. + At startup, VisiData will automatically import this ``plugins`` package and all the included plugins. To publish a plugin, create a public repo with a .py file. To package it within VisiData, `open a PR on the VisiData repo `_, placing the code in the `the experimental folder `_. @@ -31,21 +32,16 @@ hello.py Press ``0`` to show display options.disp_hello on the status line.''' __author__ = 'Jo Baz ' - __version__ = '1.0' vd.option('disp_hello', 'Hello world!', 'string to display for hello-world command') BaseSheet.addCommand('0', 'hello-world', 'status(options.disp_hello)') -If planning to open a PR on the VisiData repo, make sure the plugin contains: - -* a ``__version__`` of the current release - .. note:: Notes: - There should be a searchable docstring description of the core features. -- Include at least the author and version metadata elements. +- Optionally include author metadata. - Options at the top, commands at the bottom. - Avoid toplevel imports of non-stdlib Python extensions.