summaryrefslogtreecommitdiff
path: root/PyMca5/PyMcaCore/StackPluginBase.py
diff options
context:
space:
mode:
Diffstat (limited to 'PyMca5/PyMcaCore/StackPluginBase.py')
-rw-r--r--PyMca5/PyMcaCore/StackPluginBase.py11
1 files changed, 9 insertions, 2 deletions
diff --git a/PyMca5/PyMcaCore/StackPluginBase.py b/PyMca5/PyMcaCore/StackPluginBase.py
index 78f9bb2..d586a1f 100644
--- a/PyMca5/PyMcaCore/StackPluginBase.py
+++ b/PyMca5/PyMcaCore/StackPluginBase.py
@@ -33,8 +33,15 @@ __copyright__ = "European Synchrotron Radiation Facility, Grenoble, France"
__doc__ = """
A Stack plugin is a module that will be automatically added to the PyMca stack windows
-in order to perform user defined operations on the data stack. It has to
-inherit the :class:`StackPluginBase` class and implement the following methods:
+in order to perform user defined operations on the data stack.
+
+Plugins can be automatically installed provided they are in the appropriate place:
+
+ - In the user home directory (POSIX systems): *${HOME}/.pymca/plugins*
+ or *${HOME}/PyMca5/plugins* (older PyMca installation)
+ - In *"My Documents\\\\PyMca\\\\plugins"* (Windows)
+
+It has to inherit the :class:`StackPluginBase` class and implement the following methods:
- :meth:`StackPluginBase.getMethods`
- :meth:`StackPluginBase.getMethodToolTip` (optional but convenient)