From 56ad78c333a9be02b1a0563816388cc16077f8ec Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Thu, 19 Jun 2014 23:57:35 +0200 Subject: [PATCH] docs: Add more details on Mopidy.js calling convention --- docs/api/js.rst | 9 ++++++++- docs/changelog.rst | 6 ++++-- js/README.md | 3 ++- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/api/js.rst b/docs/api/js.rst index 461e4323..ff333992 100644 --- a/docs/api/js.rst +++ b/docs/api/js.rst @@ -129,7 +129,14 @@ When creating an instance, you can specify the following settings: Using named arguments also makes the code more readable, and more resistent to future API changes. - For backwards compatibility, the default is "by-position-only". + .. note:: + + For backwards compatibility, the default is "by-position-only". In the + future, the default will change to "by-position-or-by-name". You should + explicitly set this setting to your choice, so you won't be affected + when the default changes. + + .. versionadded:: 0.19 (Mopidy.js 0.4) ``webSocket`` An existing WebSocket object to be used instead of creating a new diff --git a/docs/changelog.rst b/docs/changelog.rst index 6a97790d..f493f4cc 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -78,6 +78,8 @@ Feature release. Mopidy's HTTP server among other Zeroconf-published HTTP servers on the local network. +**Mopidy.js client library** + - Update Mopidy.js to use when.js 3. If you maintain a Mopidy client, you should review the `differences between when.js 2 and 3 `_ @@ -93,8 +95,8 @@ Feature release. ``Mopidy.ConnectionError``. - Add support for method calls with by-name arguments. The old calling - convention, by-position-only, is still the default. See the :ref:`mopidy-js` - docs for details. + convention, ``by-position-only``, is still the default, but this will + probably change in the future. See the :ref:`mopidy-js` docs for details. **MPD frontend** diff --git a/js/README.md b/js/README.md index 9199615b..b6be8b76 100644 --- a/js/README.md +++ b/js/README.md @@ -83,7 +83,8 @@ Changelog ### 0.4.0 (UNRELEASED) - Add support for method calls with by-name arguments. The old calling - convention, by-position-only, is still the default. See the docs for details. + convention, "by-position-only", is still the default, but this will change in + the future. See the docs for details. ### 0.3.0 (2014-06-16)