Skip to content

Commit

Permalink
Docs: Fix up developer docs on DataConnector (params were wrong)
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredgrubb committed Mar 4, 2014
1 parent ae47311 commit c44d11d
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions master/docs/developer/data.rst
Expand Up @@ -99,11 +99,12 @@ Within the buildmaster process, the root of the data API is available at `self.m
Get the endpoint responsible for the given path, along with any arguments extracted from the path.
This can be used by callers that need access to information from the endpoint beyond that returned from ``get``.

.. py:method:: startConsuming(callback, options, kwargs)
.. py:method:: startConsuming(callback, options, path)
:param callback: a function to call for each message
:param options: dictionary containing model-specific options
:param kwargs: a dictionary describing the resource to control, extracted from the path
:param tuple path: A tuple of path elements representing the API path.
Numbers can be passed as strings or integers.
:raises: :py:exc:`~buildbot.data.exceptions.InvalidPathError`

This method implements the subscriptions section.
Expand All @@ -122,11 +123,12 @@ Within the buildmaster process, the root of the data API is available at `self.m
data, please use this API, rather than directly call mq.
It ensures the event is sent to all the routingkeys specified by eventPathPatterns

.. py:method:: control(action, args, kwargs)
.. py:method:: control(action, args, path)
:param action: a short string naming the action to perform
:param args: dictionary containing arguments for the action
:param kwargs: a dictionary describing the resource to control, extracted from the path
:param tuple path: A tuple of path elements representing the API path.
Numbers can be passed as strings or integers.
:raises: :py:exc:`~buildbot.data.exceptions.InvalidPathError`
:returns: a resource or list via Deferred, or None

Expand Down

0 comments on commit c44d11d

Please sign in to comment.