From 0c090499c58f1525712cf2d3f0de61a42395e657 Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Fri, 12 Apr 2013 01:34:21 +0200 Subject: [PATCH] docs: Document 'config' arg to frontend actors --- docs/api/frontends.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/api/frontends.rst b/docs/api/frontends.rst index 58436c03..6da5d337 100644 --- a/docs/api/frontends.rst +++ b/docs/api/frontends.rst @@ -13,9 +13,12 @@ The following requirements applies to any frontend implementation: `_ actor, called the "main actor" from here on. -- The main actor MUST accept a constructor argument ``core``, which will be an - :class:`ActorProxy ` for the core actor. This object - gives access to the full :ref:`core-api`. +- The main actor MUST accept two constructor arguments: + + - ``config``, which is a dict structure with the entire Mopidy configuration. + + - ``core``, which will be an :class:`ActorProxy ` for + the core actor. This object gives access to the full :ref:`core-api`. - It MAY use additional actors to implement whatever it does, and using actors in frontend implementations is encouraged.