From a2e08c6d4e4a638aea2d4be2e9c039558bbae76c Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Sat, 13 Apr 2013 14:04:54 +0200 Subject: [PATCH] docs: Add note about extension's API usage --- docs/api/index.rst | 2 ++ docs/extensiondev.rst | 8 ++++++++ 2 files changed, 10 insertions(+) diff --git a/docs/api/index.rst b/docs/api/index.rst index 6313b7a5..cb7014f1 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -1,3 +1,5 @@ +.. _api-ref: + ************* API reference ************* diff --git a/docs/extensiondev.rst b/docs/extensiondev.rst index 5530d2f2..34b26e57 100644 --- a/docs/extensiondev.rst +++ b/docs/extensiondev.rst @@ -329,3 +329,11 @@ all your custom GStreamer elements. For examples of custom GStreamer elements implemented in Python, see :mod:`mopidy.audio.mixers`. + + +Use of Mopidy APIs +================== + +When writing an extension, you should only use APIs documented at +:ref:`api-ref`. Other parts of Mopidy, like :mod:`mopidy.utils` may change at +any time, and is not something extensions should rely on being stable.