From 793a097e03ed1c1616ec5fa2440583d59654fa0b Mon Sep 17 00:00:00 2001 From: Pierre Tardy Date: Wed, 12 Oct 2016 10:15:49 +0200 Subject: [PATCH] doc clarifications --- master/docs/developer/utils.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/master/docs/developer/utils.rst b/master/docs/developer/utils.rst index 700285844db1..6c7cc54d55bd 100644 --- a/master/docs/developer/utils.rst +++ b/master/docs/developer/utils.rst @@ -891,7 +891,7 @@ For example, a particular daily scheduler could be configured on multiple master This class implements a generic Service that needs to be instantiated as a singleton according to its parameters. It is a common use case to need this for accessing remote services. Having a singleton to access a remote allows to limit the number of simultaneous access to the same services. - Thus, several completely independent buildbot services can use that singleton to access the service, and automatically synchronize themselves to not overwhelm it. + Thus, several completely independent Buildbot services can use that singleton to access the service, and automatically synchronize themselves to not overwhelm it. .. py:method:: __init__(self, *args, **kwargs) @@ -909,8 +909,8 @@ For example, a particular daily scheduler could be configured on multiple master Class method. Takes same arguments as the constructor of the service. Get a unique name for that instance of a service. - Used to decide if we need to create a new object. - Default implementation will hash args and kwargs and use ``_`` as the name + This returned name is the key inside the parent's service dictionary that is used to decide if the instance has already been created before or if there is a need to create a new object. + Default implementation will hash args and kwargs and use ``_`` as the name. .. py:method:: getService(cls, parentService, *args, **kwargs) @@ -922,8 +922,6 @@ For example, a particular daily scheduler could be configured on multiple master Construct an instance of the service if needed, and place it at the beginning of the `parentService` service list. Placing it at the beginning will guarantee that the singleton will be stopped after the other services. - - .. py:class:: BuildbotService This class is the combinations of all `Service` classes implemented in buildbot.