diff --git a/docs/contributing.rst b/docs/contributing.rst index 6562afc8..ba52839c 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -12,6 +12,7 @@ General guidelines * **master should always be releasable**. Incomplete features should live in branches. This ensures that any small bug fixes can be quickly released. * **The ideal commit** should bundle together the implementation, unit tests and associated documentation updates. The commit message should link to an associated issue. +* **New plugin hooks** should only be shipped if accompanied by a separate release of a non-demo plugin that uses them. .. _devenvironment: diff --git a/docs/plugins.rst b/docs/plugins.rst index 17fd64df..a28092a3 100644 --- a/docs/plugins.rst +++ b/docs/plugins.rst @@ -891,6 +891,9 @@ register_facet_classes() Return a list of additional Facet subclasses to be registered. +.. warning:: + The design of this plugin hook is unstable and may change. See `issue 830 `__. + Each Facet subclass implements a new type of facet operation. The class should look like this: .. code-block:: python