forked from openlp/openlp
registry: code standards
This commit is contained in:
parent
d6a57aa5cf
commit
ec56f5ff01
@ -37,8 +37,8 @@ log = logging.getLogger(__name__)
|
|||||||
|
|
||||||
class Registry(object):
|
class Registry(object):
|
||||||
"""
|
"""
|
||||||
This is the Component Registry. It is a singleton object and is used to provide a
|
This is the Component Registry. It is a singleton object and is used to provide a look up service for common
|
||||||
look up service for common objects.
|
objects.
|
||||||
"""
|
"""
|
||||||
log.info(u'Registry loaded')
|
log.info(u'Registry loaded')
|
||||||
__instance__ = None
|
__instance__ = None
|
||||||
@ -97,8 +97,8 @@ class Registry(object):
|
|||||||
|
|
||||||
def remove(self, key):
|
def remove(self, key):
|
||||||
"""
|
"""
|
||||||
Removes the registry value from the list based on the key passed in
|
Removes the registry value from the list based on the key passed in (Only valid and active for testing
|
||||||
(Only valid and active for testing framework).
|
framework).
|
||||||
|
|
||||||
``key``
|
``key``
|
||||||
The service to be deleted.
|
The service to be deleted.
|
||||||
@ -114,9 +114,9 @@ class Registry(object):
|
|||||||
Register an event and associated function to be called
|
Register an event and associated function to be called
|
||||||
|
|
||||||
``event``
|
``event``
|
||||||
The function description like "config_updated" or "live_display_hide" where a number of places in the
|
The function description like "config_updated" or "live_display_hide" where a number of places in the code
|
||||||
code will/may need to respond to a single action and the caller does not need to understand or know about
|
will/may need to respond to a single action and the caller does not need to understand or know about the
|
||||||
the recipients.
|
recipients.
|
||||||
|
|
||||||
``function``
|
``function``
|
||||||
The function to be called when the event happens.
|
The function to be called when the event happens.
|
||||||
|
Loading…
Reference in New Issue
Block a user