From f96a22e5cbc778ef555dc9c241a6906a411af390 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Thu, 7 May 2015 21:40:52 +0200 Subject: [PATCH] docs: Remove note on how to access core attributes The corresponding methods are now fully documented and the old attributes are deprecated. --- docs/api/http.rst | 11 +++-------- docs/api/js.rst | 11 ++++------- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/docs/api/http.rst b/docs/api/http.rst index e428e471..f2a50b27 100644 --- a/docs/api/http.rst +++ b/docs/api/http.rst @@ -62,14 +62,9 @@ JSON-RPC 2.0 messages can be recognized by checking for the key named please refer to the `JSON-RPC 2.0 spec `_. -All methods (not attributes) in the :ref:`core-api` is made available through -JSON-RPC calls over the WebSocket. For example, -:meth:`mopidy.core.PlaybackController.play` is available as the JSON-RPC method -``core.playback.play``. - -The core API's attributes is made available through setters and getters. For -example, the attribute :attr:`mopidy.core.PlaybackController.current_track` is -available as the JSON-RPC method ``core.playback.get_current_track``. +All methods in the :ref:`core-api` is made available through JSON-RPC calls +over the WebSocket. For example, :meth:`mopidy.core.PlaybackController.play` is +available as the JSON-RPC method ``core.playback.play``. Example JSON-RPC request:: diff --git a/docs/api/js.rst b/docs/api/js.rst index 29866d14..8771d48c 100644 --- a/docs/api/js.rst +++ b/docs/api/js.rst @@ -189,13 +189,10 @@ you've hooked up an errback (more on that a bit later) to the promise returned from the call, the errback will be called with a ``Mopidy.ConnectionError`` instance. -All methods in Mopidy's :ref:`core-api` is available via Mopidy.js. The core -API attributes is *not* available, but that shouldn't be a problem as we've -added (undocumented) getters and setters for all of them, so you can access the -attributes as well from JavaScript. For example, the -:attr:`mopidy.core.PlaybackController.state` attribute is available in -JSON-RPC as the method ``core.playback.get_state`` and in Mopidy.js as -``mopidy.playback.getState()``. +All methods in Mopidy's :ref:`core-api` is available via Mopidy.js. For +example, the :meth:`mopidy.core.PlaybackController.get_state` method is +available in JSON-RPC as the method ``core.playback.get_state`` and in +Mopidy.js as ``mopidy.playback.getState()``. Both the WebSocket API and the JavaScript API are based on introspection of the core Python API. Thus, they will always be up to date and immediately reflect